Developer Announcements

hseligson
HubSpot Employee
HubSpot Employee

Introducing Custom Association Limits for Associations API

Starting July 30th, 2024, HubSpot users can now configure custom limits for the number of associated records of a particular object type or a label to a specific object type via the public Associations API. This enhancement provides more flexibility and control over record associations, enabling users to tailor their HubSpot environment to better suit their business processes

hseligson_0-1722351163186.gif

What's changing?

Custom Association Limits

Users can set specific limits on the number of associations for different object types, but these custom limits can only be configured to be lower than their existing subscription limits. These custom limits can be applied to both general object types and specific labels within an object type.

For example:

  • Users can limit the number of contacts associated with a deal record.
  • Users can ensure that only one "Decision-maker" contact can be associated with a company record.

Important note: Label limits must always be less than or equal to the object limit if it is set.

Examples of Validation

  • If a user sets an object limit to 10 and then tries to set a label limit of 11, it will fail, and an error message will be returned providing the valid range, i.e., 1-9.
  • If a user configures a label limit of 10 and then attempts to set an object limit of 9, it will also fail. An error message will indicate the allowed range must be greater than the existing label limits (i.e., >10).

These validations are outlined in the Knowledge Base article, and standard validations will apply as detailed there.

 

API Endpoints

New endpoints in the Associations API allow for programmatic configuration of these custom limits. For detailed information on configuring custom association limits, refer to this Knowledge Base article, and review the updated Associations API documentation for comprehensive details on the new association configuration endpoints.

  • GET ​/definitions​/configurations​/all
  • GET ​/definitions​/configurations​/{fromObjectType}​/{toObjectType}
  • POST ​/definitions​/configurations​/{fromObjectType}​/{toObjectType}​/batch​/create
  • POST ​/definitions​/configurations​/{fromObjectType}​/{toObjectType}​/batch​/purge
  • POST ​/definitions​/configurations​/{fromObjectType}​/{toObjectType}​/batch​/update

These new endpoints enable HubSpot users to set custom association limits programmatically, offering enhanced control over their CRM data and supporting various use cases. For instance, users can manage associations between deals and companies, limit the number of tasks linked to a contact, or ensure unique role-based associations within records, such as assigning only one “Decision-maker” to a company.

 

When is it happening?

This change goes into effect on July 30th, 2024. Questions or concerns? Please post below in our peer-to-peer developer community.

0 Replies 0

0 Replies

No replies on this post just yet

No one has replied to this post quite yet. Check back soon to see if someone has a solution, or submit your own reply if you know how to help! Karma is real.

Reply to post

Need help replying? Check out our Community Guidelines