There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Create multiple associations between CRM objects

Last updated May 15, 2023

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:

crm.objects.companies.write
crm.objects.contacts.write
crm.objects.deals.write
tickets
e-commerce

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 private app access token Authorization: Bearer {token} header  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.

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example PUT URL: https://api.hubapi.com/crm-associations/v1/associations/create-batch Example PUT JSON (associating two contacts with the same ticket): [ { "fromObjectId": 496346, "toObjectId": 176602, "category": "HUBSPOT_DEFINED", "definitionId": 15 }, { "fromObjectId": 491646, "toObjectId": 176602, "category": "HUBSPOT_DEFINED", "definitionId": 15 } ] Returns a 204 No Content response on success. Returns a 400 response if there are any errors with the associations. The response will include a list of error messsages for each issue. { "status": "error", "message": "One or more associations are invalid", "errors": [ "CONTACT=1 is not valid" ] }