Create multiple associations between CRM objects

PUT /crm-associations/v1/associations/create-batch

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

contacts

Create multiple associations between CRM objects. The JSON data in the PUT request would be a list of associations, with each one representing a single association between 2 objects (for example, a ticket to a contact). To associate one object with multiple other objects (i.e. to associate a ticket with 2 different contacts), you would need to include multiple association entries (one for associating the ticket with contact A, and another to associate the ticket with contact B).

Up to 100 associations may be created in a single request.

Returns a 400 response if there are any issues with the association. If there are any errors, the entire request will fail and none of the associations will be created.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header or hapikey={key} query parameter. Used to authenticate the request. Please see this page for more details about authentication.
From object "fromObjectId":
Used in the request JSON
The ID of the object being associated.
To object "toObjectId":
Used in the request JSON
The ID of the object the from object is being associated with.
Category "category":
Used in the request JSON
The category of the association. Currently this must be "HUBSPOT_DEFINED"
Association definition. "definitionId":
Used in the request JSON
The ID of the association definition. See the table on the overview page for a list of those IDs.