Create a dependant

POST /api/v1/client/{client_uuid}/dependant

Headers

Path parameters

client_uuid string Required

application/json

Body Required

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.
shared_owner_uuid string

Optional UUID of an owner account. The client must be a shared type.

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.
- shared_owner_type string
  
  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
  
  The owner of the dependant. Only provided if the shared_owner_type is "individual".

POST /api/v1/client/{client_uuid}/dependant

curl \
 -X POST https://api.plannrcrm.com/api/v1/client/client_uuid/dependant \
 -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 '{"first_name":"Christopher","last_name":"Nolan","known_as":"Chris","relationship":"Brother","date_of_birth":"2004-10-16","is_financially_dependant":"true","notes":"Example notes","shared_owner_uuid":"5e7ea7d6-c817-4f75-9841-1f16f0be0433"}'

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
{
  "first_name": "Christopher",
  "last_name": "Nolan",
  "known_as": "Chris",
  "relationship": "Brother",
  "date_of_birth": "2004-10-16",
  "is_financially_dependant": "true",
  "notes": "Example notes",
  "shared_owner_uuid": "5e7ea7d6-c817-4f75-9841-1f16f0be0433"
}

Response examples (201)

{
  "name": "Christopher Nolan",
  "uuid": "0aff5350-ae1b-474c-aedb-f3b725a6f1c5",
  "notes": "Example notes",
  "known_as": "Chris",
  "last_name": "Nolan",
  "created_at": "2024-10-16T11:10:14+01:00",
  "first_name": "Christopher",
  "updated_at": "2024-10-16T11:10:14+01:00",
  "relationship": "Brother",
  "shared_owner": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "6db29ada-956a-4728-b7e3-1545f6ab229d",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-10-16T11:10:14+01:00",
    "first_name": "Gareth",
    "updated_at": "2024-10-16T11:10:14+01: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": "2024-10-16T11:10:14+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-10-16T11:10:14+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-10-16T11:10:14+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-10-16T11:10:14+01:00"
  },
  "date_of_birth": "1984-10-16T11:10:14+01:00",
  "shared_owner_type": "individual",
  "is_financially_dependant": true
}