Associated Contacts

The Associated Contact is an object used to present a relationship between a deal and a contact. In addition, each Associated Contact is assigned a role that corresponds to the role it plays in the deal.

With every deal, there might be any number of Associated Contacts.

Properties

Attribute Description
contact_id number

Unique identifier of the contact to be associated with the deal.

role string

Role name.

Possible values:

  • involved
created_at string readonly

Date and time that the associated contact was created in UTC (ISO8601 format).

updated_at string readonly

Date and time of the last update on the associated contact in UTC (ISO8601 format).


Endpoints


Retrieve deal's associated contacts

Returns all deal associated contacts.

Parameters

Attribute Description
page number optional

Page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page.

e.g. ?page=2
per_page number optional

Number of records to return per page. Default limit is 25 and the maximum number that can be returned is 100.

e.g. ?per_page=20

Create an associated contact

Creates a deal’s associated contact and its role. If the specified deal or contact does not exist, the request will return an error.

Parameters

Attribute Description
contact_id number required

Unique identifier of the contact to be associated with the deal.

e.g. "contact_id": "2"
role string optional

Role name. Default value: involved.

e.g. "role": "involved"

Remove an associated contact

Remove a deal’s associated contact. If a deal with the supplied unique identifier does not exist, it returns an error. This operation cannot be undone.

Parameters

Attribute Description
deal_id number required

Unique identifier of the deal.

e.g. ?deal_id=1
contact_id number required

Unique identifier of the contact.

e.g. ?contact_id=2