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":["07651917-b8e3-4d45-9459-68936178bfb7","8ab7c9fa-3891-4f04-b314-36a7d356d483"],"first_name":"Christopher","last_name":"Nolan","known_as":"Chris","relationship":"Brother","date_of_birth":"2005-10-08","is_financially_dependant":"true","notes":"Example notes"}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"account_uuids": [
"07651917-b8e3-4d45-9459-68936178bfb7",
"8ab7c9fa-3891-4f04-b314-36a7d356d483"
],
"first_name": "Christopher",
"last_name": "Nolan",
"known_as": "Chris",
"relationship": "Brother",
"date_of_birth": "2005-10-08",
"is_financially_dependant": "true",
"notes": "Example notes"
}
Response examples (201)
{
"name": "Christopher Nolan",
"uuid": "d9ba9e7a-d4b2-4c2c-88a8-10c9501979e5",
"notes": "Example notes",
"accounts": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "f5627d45-0bbc-4289-a2e0-30ba353100c1",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-10-08T10:40:17+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-08T10:40:17+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"known_as": "Chris",
"last_name": "Nolan",
"created_at": "2025-10-08T10:40:17+01:00",
"first_name": "Christopher",
"updated_at": "2025-10-08T10:40:17+01:00",
"relationship": "Brother",
"shared_owner": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "686d448a-a242-416f-a445-d51517558269",
"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-10-08T10:40:17+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-08T10:40:17+01:00",
"with_login": true,
"inactive_at": "2025-10-08",
"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-10-08T10:40:17+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-08T10:40:17+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-10-08T10:40:17+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-08T10:40:17+01:00"
},
"date_of_birth": "2013-10-08T10:40:17+01:00",
"shared_owner_type": "individual",
"is_financially_dependant": true
}