Create a dependant

POST /api/v2/dependants

Headers

application/json

Body Required

account_uuids array[string] 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.
last_name string Required

The last name of the dependant.
known_as string

An optional nickname for the dependant.
relationship string Required

The relationship of the dependant.
date_of_birth date

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

Optional notes for the dependant.

Responses

201 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.
  
  Additional properties are allowed.
- 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".
  
  Additional properties are allowed.

POST /api/v2/dependants

curl \
 -X POST https://api.plannrcrm.com/api/v2/dependants \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"account_uuids":["858137e4-b4c2-453f-8a19-aeaed794e53a","f24d63e1-ca2f-4c45-9d42-f106a10ccb8f"],"first_name":"Christopher","last_name":"Nolan","known_as":"Chris","relationship":"Brother","date_of_birth":"2005-01-17","is_financially_dependant":"true","notes":"Example notes"}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "account_uuids": [
    "858137e4-b4c2-453f-8a19-aeaed794e53a",
    "f24d63e1-ca2f-4c45-9d42-f106a10ccb8f"
  ],
  "first_name": "Christopher",
  "last_name": "Nolan",
  "known_as": "Chris",
  "relationship": "Brother",
  "date_of_birth": "2005-01-17",
  "is_financially_dependant": "true",
  "notes": "Example notes"
}

Response examples (201)

{
  "name": "Christopher Nolan",
  "uuid": "c46c1de1-f5f2-4a81-8e61-ede7c1bb6c11",
  "notes": "Example notes",
  "accounts": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "11f63123-3f50-45f0-b414-a43510a66ebb",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-01-17T11:18:33+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-01-17T11:18:33+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "known_as": "Chris",
  "last_name": "Nolan",
  "created_at": "2025-01-17T11:18:33+00:00",
  "first_name": "Christopher",
  "updated_at": "2025-01-17T11:18:33+00:00",
  "relationship": "Brother",
  "shared_owner": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "f1109b92-732d-485d-880e-68dca9bcef9e",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-01-17T11:18:33+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-01-17T11:18:33+00:00",
    "with_login": true,
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-01-17T11:18:33+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-01-17T11:18:33+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-01-17T11:18:33+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-01-17T11:18:33+00:00"
  },
  "date_of_birth": "2013-01-17T11:18:33+00:00",
  "shared_owner_type": "individual",
  "is_financially_dependant": true
}