Relationship

Modify a relationship

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

When modifying a relationship, you can include either a source_contact, destination_contact,source_company, destination_company, or an relationship_typedepending on the object type for the relationship.

Attributes you leave out are not changed. To switch a relationship from contacts to companies, set the contact attributes to null and the company attributes to the new references. Send "relationship_type": null to remove the type.

A successful update returns 204 No Content.

Path Params
int32
required

The relationship ID

Body Params
string

Reference of the source contact, e.g. /v1/contacts/1000.

string

Reference of the destination contact, e.g. /v1/contacts/1001.

string

Reference of the source company, e.g. /v1/companies/1000.

string

Reference of the destination company, e.g. /v1/companies/1001.

string

Reference of the relationship type, e.g. /v1/relationship_types/1000. Optional; send null to remove it.

string

Details (max 512 characters).

Responses
204

204 No Content

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json