Create a client link

POST /api/v1/client/{client_uuid}/linked-clients

Personal access token & O auth2

Headers

Authorization string
Content-Type string
Accept string

Path parameters

client_uuid string Required
firm string Required

uuid The UUID of the firm.
client string Required

uuid The UUID of the client.

application/json

Body Required

account_uuid string Required

The client that you would like to be linked.
relationship string Required

The relationship to the linked client.
inverse_relationship string Required

The inverse relationship to the client.

Responses

201 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The unique identifier of the linked client.
- name string
  
  The name of the linked client.
- relationship string
  
  The relationship to the linked client.

POST /api/v1/client/{client_uuid}/linked-clients

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/client/client_uuid/linked-clients' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --data '{"account_uuid":"string","relationship":"Son","inverse_relationship":"Father"}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "account_uuid": "string",
  "relationship": "Son",
  "inverse_relationship": "Father"
}

Response examples (201)

{
  "name": "Gareth",
  "uuid": "1974e014-ec6c-44c2-8869-f48400c2fd01",
  "relationship": "Father"
}