Association Types
The Association Type object represents the relationship between two objects.
Properties

idUUID
Required

remote_idString
Optional
The third-party API ID of the matching object.

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

source_object_classObject
Required

target_object_classesAssociationSubType[]
Required

remote_key_nameString
Optional

display_nameString
Optional

cardinalityEnum
Optional
Possible values include: ONE_TO_ONE, MANY_TO_ONE, MANY_TO_MANY, ONE_TO_MANY. In cases where there is no clear mapping, the original value passed through will be returned.

is_requiredBoolean
Required

This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!


GET
/custom-object-classes/{custom_object_class_id}/association-types

https://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/association-types

US
EU

Returns a list of AssociationType objects.


Query & Path Parameters

created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.

created_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

custom_object_class_idUUID
Required

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge before this date time will be returned.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Salesforce
Salesforce
Not seeing an integration that you're looking for? Submit a request for it.

This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!

POST
/custom-object-classes/{custom_object_class_id}/association-types

https://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/association-types

US
EU

Creates an AssociationType object with the given values.


Query & Path Parameters

custom_object_class_idUUID
Required

is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body Parameters

modelObject
Required
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.

source_object_classObject

target_object_classesArray

remote_key_nameString

display_nameString

cardinalityString
  • ONE_TO_ONE
    • ONE_TO_ONE

is_requiredBoolean

To include the correct model fields when making POST requests, use the GET /custom-object-classes/{custom_object_class_id}/association-types/meta/post endpoint. Learn more in our /meta guide.

This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!

GET
/custom-object-classes/{custom_object_class_id}/association-types/{id}

https://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/association-types/{id}

US
EU

Returns an AssociationType object with the given id.


Query & Path Parameters

custom_object_class_idUUID
Required

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Salesforce
Salesforce
Not seeing an integration that you're looking for? Submit a request for it.

This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!

GET
/custom-object-classes/{custom_object_class_id}/association-types/meta/post

https://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/association-types/meta/post

US
EU

Returns metadata for CRMAssociationType POSTs.


Query & Path Parameters

custom_object_class_idUUID
Required
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Salesforce
Salesforce
Not seeing an integration that you're looking for? Submit a request for it.

This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!