SMsmokeball
Contacts

Update a contact relation

Updates a relation for a specified contact.

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

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/contacts/{contactId}/relations/{relatedContactId}
  • Auth
    API key in header x-api-key and API key in header Authorization

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

Changes

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