Association Type
object represents the relationship between two objects.source_object_class
Objecttarget_object_classes
AssociationSubType[]remote_key_name
Stringdisplay_name
Stringcardinality
EnumONE_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_required
Booleanid
Stringremote_id
Stringcreated_at
Stringmodified_at
String{"source_object_class": {"id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602","origin_type": "CUSTOM_OBJECT"},"target_object_classes": [{"id": "Opportunity","origin_type": "COMMON_MODEL"}],"remote_key_name": "order_to_opportunity","display_name": "Order to Opportunity","cardinality": "ONE_TO_MANY","is_required": true,"id": "5bb73c32-3c6c-4757-ab7d-7d3540a1be31","remote_id": "93","created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z"}
This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!
https://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/association-types
Returns a list of AssociationType
objects.
Authorization
StringX-Account-Token
Stringcreated_after
Stringcreated_before
Stringcursor
Stringcustom_object_class_id
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_id
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"source_object_class": {"id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602","origin_type": "CUSTOM_OBJECT"},"target_object_classes": [{"id": "Opportunity","origin_type": "COMMON_MODEL"}],"remote_key_name": "order_to_opportunity","display_name": "Order to Opportunity","cardinality": "ONE_TO_MANY","is_required": true,"id": "5bb73c32-3c6c-4757-ab7d-7d3540a1be31","remote_id": "93","created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z"}]}
This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!
https://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/association-types
Creates an AssociationType
object with the given values.
Authorization
StringX-Account-Token
Stringcustom_object_class_id
Stringis_debug_mode
Booleanrun_async
Booleanmodel
Objectsource_object_class
Objecttarget_object_classes
Arrayremote_key_name
Stringdisplay_name
Stringcardinality
StringONE_TO_ONE
- ONE_TO_ONE
is_required
Boolean{"model": {"source_object_class": {"id": "string","origin_type": "CUSTOM_OBJECT"},"target_object_classes": [{"id": "string","origin_type": "CUSTOM_OBJECT"}],"remote_key_name": "string","display_name": "string","cardinality": "ONE_TO_ONE","is_required": false}}
{"model": {"source_object_class": {"id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602","origin_type": "CUSTOM_OBJECT"},"target_object_classes": [{"id": "Opportunity","origin_type": "COMMON_MODEL"}],"remote_key_name": "order_to_opportunity","display_name": "Order to Opportunity","cardinality": "ONE_TO_MANY","is_required": true,"id": "5bb73c32-3c6c-4757-ab7d-7d3540a1be31","remote_id": "93","created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z"},"warnings": [{"source": {"pointer": "/age"},"title": "Unrecognized Field","detail": "An unrecognized field, age, was passed in with request data.","problem_type": "UNRECOGNIZED_FIELD"}],"errors": [{"source": {},"title": "Missing Required Field","problem_type": "MISSING_REQUIRED_FIELD"}],"logs": [{"log_id": "99433219-8017-4acd-bb3c-ceb23d663832","dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_summary": {"url": "https://harvest.greenhouse.io/v1/candidates/","method": "POST","status_code": 200}}]}
This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!
https://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/association-types/{id}
Returns an AssociationType
object with the given id
.
Authorization
StringX-Account-Token
Stringcustom_object_class_id
Stringexpand
Stringid
Stringinclude_remote_data
Boolean{"source_object_class": {"id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602","origin_type": "CUSTOM_OBJECT"},"target_object_classes": [{"id": "Opportunity","origin_type": "COMMON_MODEL"}],"remote_key_name": "order_to_opportunity","display_name": "Order to Opportunity","cardinality": "ONE_TO_MANY","is_required": true,"id": "5bb73c32-3c6c-4757-ab7d-7d3540a1be31","remote_id": "93","created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z"}
This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!
https://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/association-types/meta/post
Returns metadata for CRMAssociationType
POSTs.
Authorization
StringX-Account-Token
Stringcustom_object_class_id
String{"request_schema": {},"remote_field_classes": {},"status": {"linked_account_status": "COMPLETE","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}
This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!