Associations
The
Association record refers to an instance of an Association Type.Properties
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
source_objectUUIDRequired
target_objectUUIDRequired
association_typeUUIDOptional
The association type the association belongs to.
GET
/custom-object-classes/{custom_object_class_id}/custom-objects/{object_id}/associations
https://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects/{object_id}/associations
US
EU
APAC
Returns a list of Association objects.
Query & Path Parameters
association_type_idStringOptional
If provided, will only return opportunities with this association_type.
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.
cursorStringOptional
The pagination cursor value.
custom_object_class_idUUIDRequired
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
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.
object_idUUIDRequired
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
PUT
/custom-object-classes/{source_class_id}/custom-objects/{source_object_id}/associations/{target_class_id}/{target_object_id}/{association_type_id}
Betahttps://api.merge.dev/api/crm/v1/custom-object-classes/{source_class_id}/custom-objects/{source_object_id}/associations/{target_class_id}/{target_object_id}/{association_type_id}
US
EU
APAC
Creates an Association between source_object_id and target_object_id of type association_type_id.
Query & Path Parameters
association_type_idUUIDRequired
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
source_class_idUUIDRequired
source_object_idUUIDRequired
target_class_idStringRequired
target_object_idUUIDRequired