Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Body
-
account_uuids array[string]
The UUIDs of the accounts who should own the dependant. These must only be client accounts.
-
first_name string
The first name of the dependant.
-
last_name string
The last name of the dependant.
-
known_as string
An optional nickname for the dependant.
-
relationship string
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.
PUT
/api/v2/dependants/{uuid}
curl \
--request PUT https://api.plannrcrm.com/api/v2/dependants/uuid \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"account_uuids":["ee3b572d-e2cf-450f-9a81-0b708453f740","80799314-5ec8-4eff-803f-9df9062d920e"],"first_name":"Christopher","last_name":"Nolan","known_as":"Chris","relationship":"Brother","date_of_birth":"2005-02-20","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": [
"ee3b572d-e2cf-450f-9a81-0b708453f740",
"80799314-5ec8-4eff-803f-9df9062d920e"
],
"first_name": "Christopher",
"last_name": "Nolan",
"known_as": "Chris",
"relationship": "Brother",
"date_of_birth": "2005-02-20",
"is_financially_dependant": "true",
"notes": "Example notes"
}
Response examples (200)
{
"name": "Christopher Nolan",
"uuid": "18d95e54-19c9-4208-9681-07dabd0deb01",
"notes": "Example notes",
"accounts": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "560cb4cb-0ea3-4f9e-8df5-9ef335a101a6",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-02-20T10:13:06+00:00",
"first_name": "Gareth",
"updated_at": "2025-02-20T10:13:06+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"known_as": "Chris",
"last_name": "Nolan",
"created_at": "2025-02-20T10:13:06+00:00",
"first_name": "Christopher",
"updated_at": "2025-02-20T10:13:06+00:00",
"relationship": "Brother",
"shared_owner": {
"firm": "App\\Http\\Resources\\FirmResource",
"name": "Gareth Thompson",
"role": "client",
"tags": "App\\Http\\Resources\\TagResource",
"type": "client",
"uuid": "1c1fd71e-3e9c-496b-9038-0fdc24a36613",
"email": "gareth@codepotato.co.uk",
"groups": "App\\Http\\Resources\\GroupResource",
"owners": "App\\Http\\Resources\\AccountResource",
"last_name": "Thompson",
"created_at": "2025-02-20T10:13:06+00:00",
"first_name": "Gareth",
"updated_at": "2025-02-20T10:13:06+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-02-20T10:13:06+00:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-02-20T10:13:06+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"previous_review_date": "2025-02-20T10:13:06+00:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-02-20T10:13:06+00:00"
},
"date_of_birth": "2013-02-20T10:13:06+00:00",
"shared_owner_type": "individual",
"is_financially_dependant": true
}