CAcarecycle
Customers.Relationships

Add related customer

Add a person who shares this customer's phone number, such as a spouse, or link an existing customer. Call it when POST /v2/customers returns 409 with an existingCustomerId. A person already on the number is returned instead of duplicated, so retries are safe. The person is not the number's primary unless isPrimaryForPhone is true.

post/v2/customers/{id}/related

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/customers/{id}/related
  • Auth
    API key in header x-api-key

Path parameters

idstring uuid required

Customer the person is related to

Request body

relationshipType'spouse' | 'child' | 'parent' | 'sibling' | 'power_of_attorney' | 'other' required

What the related customer is to the customer in the path, for example spouse or child

relatedCustomerIdstring uuid

Link an existing customer instead of adding a person

sharePhoneboolean

With relatedCustomerId: move that customer onto this customer's phone number as a related customer. They take the number's call and SMS opt-outs.

isPrimaryForPhoneboolean

Make the related customer the primary contact for the shared phone number: inbound calls, texts and outreach then go to them. Both customers must share the number. Applies only when the person or link is new; a repeat request does not change the primary.

Response

POST /v2/customers/:id/related Positive response

outcome'created' | 'restored' | 'existing' | 'linked' required

created: new customer on the number. restored: a deleted customer on the number came back. existing: the person was already a customer on the number (matched by clientCustomerId, MBI, or name and date of birth), nothing was created. linked: two existing customers were linked.

Changes

No recorded changes to this operation across all 2 revisions of this API.