PUT /api/v2/dependants/{uuid}
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • uuid string Required
application/json

Body

  • account_uuids array[string(uuid)] Required

    The UUIDs of the accounts who should own the dependant. These must only be client accounts.

  • first_name string Required

    The first name of the dependant.

    Maximum length is 255.

  • last_name string Required

    The last name of the dependant.

    Maximum length is 255.

  • known_as string | null

    An optional nickname for the dependant.

    Maximum length is 255.

  • relationship string Required

    The relationship of the dependant.

    Maximum length is 255.

  • date_of_birth string(date) | null

    The date of birth of the dependant. Must be in Y-m-d format. Example: 1990-12-25.

  • is_financially_dependant boolean

    Denotes if the dependant is financially dependant on the client.

  • notes string | null

    Optional notes for the dependant.

    Maximum length is 5000.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • first_name string

      The first name of the dependant.

    • last_name string

      The last name of the dependant.

    • name string

      The full name of the dependant. If known_as has been provided, the first name will be replaced with the known_as.

    • known_as string

      An optional nickname for the dependant.

    • relationship string

      The relationship of the dependant.

    • date_of_birth string

      The date of birth of the dependant.

    • is_financially_dependant boolean

      Denotes if the dependant is financially dependant on the client.

    • notes string

      Optional notes for the dependant.

    • accounts object

      Accounts that own this dependant.

      Hide accounts attributes Show accounts attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references string
    • shared_owner_type string

      @deprecated Denotes if the dependant is shared across the client or belongs to one of the owners of the client. (Only applicable for joint/business/trust clients)

    • shared_owner object

      @deprecated The owner of the dependant. Only provided if the shared_owner_type is "individual".

      Hide shared_owner attributes Show shared_owner attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • permissions object
        Hide permissions attributes Show permissions attributes object
        • firm:read array[string]
        • network:read array[string]
      • custom_fields string
      • external_references string
PUT /api/v2/dependants/{uuid} 
curl \
 --request PUT 'https://api.plannrcrm.com/api/v2/dependants/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"account_uuids":["884f7a42-6319-4de8-8f3b-422005bd1191","a3a572b6-20d4-43b4-ac5a-88ab3bf53b48","cbbea373-4f7f-45e9-90c8-b7583a1bbe35"],"first_name":"Christopher","last_name":"Nolan","known_as":"Chris","relationship":"Brother","date_of_birth":"2006-04-08","is_financially_dependant":true,"notes":"Example notes"}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "account_uuids": [
    "884f7a42-6319-4de8-8f3b-422005bd1191",
    "a3a572b6-20d4-43b4-ac5a-88ab3bf53b48",
    "cbbea373-4f7f-45e9-90c8-b7583a1bbe35"
  ],
  "first_name": "Christopher",
  "last_name": "Nolan",
  "known_as": "Chris",
  "relationship": "Brother",
  "date_of_birth": "2006-04-08",
  "is_financially_dependant": true,
  "notes": "Example notes"
}
Response examples (200) 
{
  "name": "Christopher Nolan",
  "uuid": "5c5638eb-6330-420a-bea5-486b9f1a3969",
  "notes": "Example notes",
  "accounts": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "89e84386-ff55-4244-afd0-f442901020f3",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2026-04-08T15:40:48+01:00",
    "first_name": "Gareth",
    "updated_at": "2026-04-08T15:40:48+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "known_as": "Chris",
  "last_name": "Nolan",
  "created_at": "2026-04-08T15:40:48+01:00",
  "first_name": "Christopher",
  "updated_at": "2026-04-08T15:40:48+01:00",
  "relationship": "Brother",
  "shared_owner": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "208ebc22-47d2-4b05-8c82-89b0d94473ee",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2026-04-08T15:40:48+01:00",
    "first_name": "Gareth",
    "updated_at": "2026-04-08T15:40:48+01:00",
    "with_login": true,
    "inactive_at": "2026-04-08",
    "permissions": {
      "firm:read": [
        "firm"
      ],
      "network:read": [
        "network:uuid"
      ]
    },
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "referral_code": "ABC12345",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2026-04-08T15:40:48+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2026-04-08T15:40:48+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "last_interaction_at": "2026-04-08 15:40:48",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2026-04-08T15:40:48+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2026-04-08T15:40:48+01:00"
  },
  "date_of_birth": "2014-04-08T15:40:48+01:00",
  "shared_owner_type": "individual",
  "is_financially_dependant": true
}