POST
/
contacts
/
{contactId}
/
relations
Create a contact relation
curl --request POST \
  --url https://api.smokeball.com/contacts/{contactId}/relations \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "relatedContactId": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "businessRole": "Bookkeeper"
}'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
contactId
string
required

Body

​
relatedContactId
string | null

Unique identifier of the related contact.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

​
businessRole
string | null

Business role of related contact.

Only applicable for companies (not trusts).

Example:

"Bookkeeper"

Response

When request is accepted. Returns a hypermedia 'Link' object of the contact relation to be created.

​
id
string | null
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET