Update a dependant

PUT /api/v1/client/{client_uuid}/dependant/{uuid}

Path parameters

application/json

Body

Responses

  • 200 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".

      Additional properties are allowed.
PUT /api/v1/client/{client_uuid}/dependant/{uuid} 
curl \
 -X PUT https://api.plannrcrm.com/api/v1/client/client_uuid/dependant/uuid \
 -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-11-20","is_financially_dependant":"true","notes":"Example notes","shared_owner_uuid":"ecf2c7b4-6615-4136-894a-c8b64b99c901"}'
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-11-20",
  "is_financially_dependant": "true",
  "notes": "Example notes",
  "shared_owner_uuid": "ecf2c7b4-6615-4136-894a-c8b64b99c901"
}
Response examples (200) 
{
  "name": "Christopher Nolan",
  "uuid": "23ba0dd7-2cd3-4888-bac4-73e0ad52f586",
  "notes": "Example notes",
  "known_as": "Chris",
  "last_name": "Nolan",
  "created_at": "2024-11-20T13:24:00+00:00",
  "first_name": "Christopher",
  "updated_at": "2024-11-20T13:24:00+00:00",
  "relationship": "Brother",
  "shared_owner": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "24ce7a5a-26de-42e9-a079-1d47d8b474e7",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:00+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:00+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": "2024-11-20T13:24:00+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:00+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:00+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:00+00:00"
  },
  "date_of_birth": "1984-11-20T13:24:00+00:00",
  "shared_owner_type": "individual",
  "is_financially_dependant": true
}