v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Contacts

Update a contact relation

Updates a relation for a specified contact.

put/contacts/{contactId}/relations/{relatedContactId}

Path parameters

contactIdstring required
relatedContactIdstring uuid required

Request body

relatedContactIdstring nullable

Unique identifier of the related contact.

businessRolestring nullable

Business role of related contact.

Only applicable for companies (not trusts).

Example request

{
  "relatedContactId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "businessRole": "Bookkeeper"
}

Response

When request is accepted. Returns a 'Link' object.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable