Associations
The Association
record refers to an instance of an Association Type.The Association object
Properties
source_object
ObjectOptional
target_object
ObjectOptional
association_type
StringOptional
modified_at
StringRequired
This is the datetime that this object was last updated by Merge
The Association object
JSON
{"source_object": "a8f5d29f-4e50-473f-8f12-27128ffcd37a","target_object": "da0b1963-be70-469c-9f8c-06a81d0fe759","association_type": "88a71b5c-a3cc-4bce-84ff-d18b049a4081","modified_at": "2021-10-16T00:00:00Z"}
This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!
GET
/custom-object-classes/{custom_object_class_id}/custom-objects/{object_id}/associations
Returns a list of Association
objects.
Header Parameters
Authorization
StringRequired
Token-based authentication with required prefix "Bearer"
X-Account-Token
StringRequired
Token identifying the end user.
Query & Path Parameters
association_type_id
StringOptional
If provided, will only return opportunities with this association_type.
created_after
StringOptional
If provided, will only return objects created after this datetime.
created_before
StringOptional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
custom_object_class_id
StringRequired
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_after
StringOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
StringOptional
If provided, only objects synced by Merge before this date time will be returned.
object_id
StringRequired
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
The API provider's ID for the given object.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"source_object": "a8f5d29f-4e50-473f-8f12-27128ffcd37a","target_object": "da0b1963-be70-469c-9f8c-06a81d0fe759","association_type": "88a71b5c-a3cc-4bce-84ff-d18b049a4081","modified_at": "2021-10-16T00:00:00Z"}]}
This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!
PUT
/custom-object-classes/{source_class_id}/custom-objects/{source_object_id}/associations/{target_class_id}/{target_object_id}/{association_type_id}
Creates an Association between source_object_id
and target_object_id
of type association_type_id
.
Header Parameters
Authorization
StringRequired
Token-based authentication with required prefix "Bearer"
X-Account-Token
StringRequired
Token identifying the end user.
Query & Path Parameters
association_type_id
StringRequired
is_debug_mode
BooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_async
BooleanOptional
Whether or not third-party updates should be run asynchronously.
source_class_id
StringRequired
source_object_id
StringRequired
target_class_id
StringRequired
target_object_id
StringRequired
Response
JSON
{"source_object": "a8f5d29f-4e50-473f-8f12-27128ffcd37a","target_object": "da0b1963-be70-469c-9f8c-06a81d0fe759","association_type": "88a71b5c-a3cc-4bce-84ff-d18b049a4081","modified_at": "2021-10-16T00:00:00Z"}
This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!