CAcarecycle
Customers.Relationships

Update customer relationship

Change how two linked customers are related

patch/v2/customers/{id}/relationships/{relationshipId}

Request

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

Path parameters

idstring uuid required

Customer ID

relationshipIdstring uuid required

Relationship ID

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

Response

PATCH /v2/customers/:id/relationships/:relationshipId Positive response

idstring uuid required
customerIdstring uuid required

The customer the link was added from

relatedCustomerIdstring uuid required

The customer who is the other customer's relationshipType

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

createdAtstring date-time required

Relationship creation time. ISO 8601 timestamp

updatedAtstring date-time required

Relationship last update time. ISO 8601 timestamp

Changes

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