HighLevel: Associations schemas

← Associations operations · All schemas

Create Association — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
firstObjectKey	object	Required within parent	First Objects Key
firstObjectLabel	object	Required within parent	First Objects Association Label (custom_objects.children)
key	string	Required within parent	Association's Unique key
locationId	string	Required within parent
secondObjectKey	object	Required within parent	Second Objects Key
secondObjectLabel	object	Required within parent	Second Object Association Label (contact)

Create Relation for you associated entities — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
associationId	string	Required within parent	Association's Id
firstRecordId	string	Required within parent	First Record's Id. For instance, if you have an association between a contact and a custom object, and you specify the contact as the first object while creating the association, then your firstRecordId would be the contactId
locationId	string	Required within parent	Your Sub Account's ID
secondRecordId	string	Required within parent	Second Record's Id.For instance, if you have an association between a contact and a custom object, and you specify the custom object as the second entity while creating the association, then your secondRecordId would be the customObject record Id

Delete Association — response body

Field	Type	Presence	Description and constraints
$	object	Root
deleted	boolean	Required within parent	Deletion status
id	string	Required within parent	Association Id
message	string	Required within parent

Delete Relation — response body

Field	Type	Presence	Description and constraints
$	object	Root
associationType	object	Required within parent	Association Type can be USER_DEFINED or SYSTEM_DEFINED
firstObjectKey	object	Required within parent	First Objects Key
firstObjectLabel	object	Required within parent	First Objects Association Label (custom_objects.children)
id	string	Required within parent
key	string	Required within parent	First Objects Association Label (custom_objects.children)
locationId	string	Required within parent
secondObjectKey	object	Required within parent	Second Objects Key
secondObjectLabel	object	Required within parent	Second Object Association Label (contact)

Update Association By Id — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
firstObjectLabel	object	Required within parent
secondObjectLabel	object	Required within parent