Create a client link

POST /api/v1/client/{client_uuid}/linked-clients
Personal access token & O auth2

Path parameters

  • client_uuid string Required
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/6ff8f7f6-1eb3-3525-be4a-3932c805afed/linked-clients' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"account_uuid":"string","relationship":"Son","inverse_relationship":"Father"}'
Request examples 
{
  "account_uuid": "string",
  "relationship": "Son",
  "inverse_relationship": "Father"
}
Response examples (201) 
{
  "name": "Gareth",
  "uuid": "71a9c4df-ff74-4134-818c-44a82b56b541",
  "relationship": "Father"
}