Body
Required
-
The UUIDs of the accounts who should own the dependant. These must only be client accounts.
-
The first name of the dependant.
-
The last name of the dependant.
-
An optional nickname for the dependant.
-
The relationship of the dependant.
-
The date of birth of the dependant. Must be in Y-m-d format. Example: 1990-12-25.
-
Denotes if the dependant is financially dependant on the client.
-
Optional notes for the dependant.
POST
/api/v2/dependants
curl \
--request POST 'https://api.plannrcrm.com/api/v2/dependants' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"account_uuids":["799b52f2-b958-4e9d-b12a-c9accf147163","00f64dc4-8c23-495b-ae3f-e5427118f04d"],"first_name":"Christopher","last_name":"Nolan","known_as":"Chris","relationship":"Brother","date_of_birth":"2005-08-07","is_financially_dependant":"true","notes":"Example notes"}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"account_uuids": [
"799b52f2-b958-4e9d-b12a-c9accf147163",
"00f64dc4-8c23-495b-ae3f-e5427118f04d"
],
"first_name": "Christopher",
"last_name": "Nolan",
"known_as": "Chris",
"relationship": "Brother",
"date_of_birth": "2005-08-07",
"is_financially_dependant": "true",
"notes": "Example notes"
}
Response examples (201)
{
"name": "Christopher Nolan",
"uuid": "9a1ce84a-260e-4000-b3a9-4aab9e5ddbcb",
"notes": "Example notes",
"accounts": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "0be17476-2398-4f27-93c7-b5e2670bce66",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-08-07T13:41:47+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:47+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"known_as": "Chris",
"last_name": "Nolan",
"created_at": "2025-08-07T13:41:47+01:00",
"first_name": "Christopher",
"updated_at": "2025-08-07T13:41:47+01:00",
"relationship": "Brother",
"shared_owner": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "5a1d3234-4ad2-4c5f-95a8-ea068a40d1fa",
"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": "2025-08-07T13:41:47+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:47+01:00",
"with_login": true,
"inactive_at": "2025-08-07",
"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-08-07T13:41:47+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-08-07T13:41:47+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-08-07T13:41:47+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-08-07T13:41:47+01:00"
},
"date_of_birth": "2013-08-07T13:41:47+01:00",
"shared_owner_type": "individual",
"is_financially_dependant": true
}