Custom Object Classes
The Custom Object Class object is used to represent a Custom Object Schema in the remote system.The CustomObjectClass object
Properties
name
Stringdescription
Stringlabels
Objectfields
RemoteFieldClassForCustomObjectClass[]association_types
Arrayid
Stringremote_id
String{"name": "order","description": "Order object","labels": {"singular": "Order","plural": "Orders"},"fields": [{"display_name": "Order ID","remote_key_name": "order_id","description": "The unique ID for the order.","is_required": true,"is_nested_list": false,"field_type": "string","field_format": null,"field_choices": [],"item_schema": null},{"display_name": "Order Quantity","remote_key_name": "order_quantity","description": "The number of items ordered.","is_required": true,"is_nested_list": false,"field_type": "number","field_format": null,"field_choices": [],"item_schema": null},{"display_name": "Customer Type","remote_key_name": "customer_type","description": "The type of customer.","is_required": true,"is_nested_list": false,"field_type": "string","field_format": null,"field_choices": ["New","Returning"],"item_schema": null}],"association_types": [{}],"id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602","remote_id": "9579977"}
/custom-object-classes
CLOSED BETAReturns a list of CustomObjectClass
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
created_after
Stringcreated_before
Stringcursor
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_id
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"name": "order","description": "Order object","labels": {"singular": "Order","plural": "Orders"},"fields": [{"display_name": "Order ID","remote_key_name": "order_id","description": "The unique ID for the order.","is_required": true,"is_nested_list": false,"field_type": "string","field_format": null,"field_choices": [],"item_schema": null},{"display_name": "Order Quantity","remote_key_name": "order_quantity","description": "The number of items ordered.","is_required": true,"is_nested_list": false,"field_type": "number","field_format": null,"field_choices": [],"item_schema": null},{"display_name": "Customer Type","remote_key_name": "customer_type","description": "The type of customer.","is_required": true,"is_nested_list": false,"field_type": "string","field_format": null,"field_choices": ["New","Returning"],"item_schema": null}],"association_types": [{}],"id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602","remote_id": "9579977"}]}
/custom-object-classes/{custom_object_class_id}/association-types
CLOSED BETAReturns a list of AssociationType
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
created_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"}]}
/custom-object-classes/{custom_object_class_id}/association-types
CLOSED BETACreates an AssociationType
object with the given values.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
custom_object_class_id
Stringis_debug_mode
Booleanrun_async
BooleanBody Parameters
model
ObjectModel Parameters
source_object_class
Objecttarget_object_classes
Arrayremote_key_name
Stringdisplay_name
Stringcardinality
Stringis_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"},"warnings": [{"source": {"pointer": "/age"},"title": "Unrecognized Field","detail": "An unrecognized field, age, was passed in with request data.","problem_type": "UNRECOGNIZED_FIELD"}],"errors": [{"source": {"pointer": "/model/custom_fields"},"title": "Missing Required Field","detail": "custom_fields is a required field on model.","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}}]}
/custom-object-classes/{custom_object_class_id}/association-types/{id}
CLOSED BETAReturns an AssociationType
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
custom_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"}
/custom-object-classes/{custom_object_class_id}/association-types/meta/post
Returns metadata for CRMAssociationType
POSTs.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
custom_object_class_id
String{"request_schema": {},"status": {"linked_account_status": "string","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}
/custom-object-classes/{custom_object_class_id}/custom-objects
CLOSED BETAReturns a list of CustomObject
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
created_after
Stringcreated_before
Stringcursor
Stringcustom_object_class_id
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleaninclude_remote_fields
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_id
String{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"object_class": "ff1ff4cb-a66b-47dc-8e2a-50388049e602","fields": {"order_id": "4183634295","order_quantity": 50,"customer_type": "Returning"},"remote_id": "4183634295","id": "da0b1963-be70-469c-9f8c-06a81d0fe759","remote_fields": [{"value": {}}]}]}
/custom-object-classes/{custom_object_class_id}/custom-objects
CLOSED BETACreates a CustomObject
object with the given values.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
custom_object_class_id
Stringis_debug_mode
Booleanrun_async
BooleanBody Parameters
model
ObjectModel Parameters
fields
Object{"model": {"fields": {}}}
{"model": {"object_class": "ff1ff4cb-a66b-47dc-8e2a-50388049e602","fields": {"order_id": "4183634295","order_quantity": 50,"customer_type": "Returning"},"remote_id": "4183634295","id": "da0b1963-be70-469c-9f8c-06a81d0fe759","remote_fields": [{"value": {}}]},"warnings": [{"source": {"pointer": "/age"},"title": "Unrecognized Field","detail": "An unrecognized field, age, was passed in with request data.","problem_type": "UNRECOGNIZED_FIELD"}],"errors": [{"source": {"pointer": "/model/custom_fields"},"title": "Missing Required Field","detail": "custom_fields is a required field on model.","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}}]}
/custom-object-classes/{custom_object_class_id}/custom-objects/{id}
CLOSED BETAReturns a CustomObject
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
custom_object_class_id
Stringid
Stringinclude_remote_data
Booleaninclude_remote_fields
Boolean{"object_class": "ff1ff4cb-a66b-47dc-8e2a-50388049e602","fields": {"order_id": "4183634295","order_quantity": 50,"customer_type": "Returning"},"remote_id": "4183634295","id": "da0b1963-be70-469c-9f8c-06a81d0fe759","remote_fields": [{"value": {}}]}
/custom-object-classes/{custom_object_class_id}/custom-objects/{id}
CLOSED BETAUpdates a CustomObject
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
custom_object_class_id
Stringid
Stringis_debug_mode
Booleanrun_async
BooleanBody Parameters
model
ObjectModel Parameters
fields
Object{"model": {"fields": {}}}
{"model": {"object_class": "ff1ff4cb-a66b-47dc-8e2a-50388049e602","fields": {"order_id": "4183634295","order_quantity": 50,"customer_type": "Returning"},"remote_id": "4183634295","id": "da0b1963-be70-469c-9f8c-06a81d0fe759","remote_fields": [{"value": {}}]},"warnings": [{"source": {"pointer": "/age"},"title": "Unrecognized Field","detail": "An unrecognized field, age, was passed in with request data.","problem_type": "UNRECOGNIZED_FIELD"}],"errors": [{"source": {"pointer": "/model/custom_fields"},"title": "Missing Required Field","detail": "custom_fields is a required field on model.","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}}]}
/custom-object-classes/{custom_object_class_id}/custom-objects/{object_id}/associations
CLOSED BETAReturns a list of Association
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
association_type_id
Stringcreated_after
Stringcreated_before
Stringcursor
Stringcustom_object_class_id
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringobject_id
Stringpage_size
Integerremote_id
String{"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"}]}
/custom-object-classes/{custom_object_class_id}/custom-objects/meta/patch/{id}
Returns metadata for CRMCustomObject
PATCHs.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
custom_object_class_id
Stringid
String{"request_schema": {},"status": {"linked_account_status": "string","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}
/custom-object-classes/{custom_object_class_id}/custom-objects/meta/post
Returns metadata for CRMCustomObject
POSTs.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
custom_object_class_id
String{"request_schema": {},"status": {"linked_account_status": "string","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}
/custom-object-classes/{id}
CLOSED BETAReturns a CustomObjectClass
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
expand
Stringid
Stringinclude_remote_data
Boolean{"name": "order","description": "Order object","labels": {"singular": "Order","plural": "Orders"},"fields": [{"display_name": "Order ID","remote_key_name": "order_id","description": "The unique ID for the order.","is_required": true,"is_nested_list": false,"field_type": "string","field_format": null,"field_choices": [],"item_schema": null},{"display_name": "Order Quantity","remote_key_name": "order_quantity","description": "The number of items ordered.","is_required": true,"is_nested_list": false,"field_type": "number","field_format": null,"field_choices": [],"item_schema": null},{"display_name": "Customer Type","remote_key_name": "customer_type","description": "The type of customer.","is_required": true,"is_nested_list": false,"field_type": "string","field_format": null,"field_choices": ["New","Returning"],"item_schema": null}],"association_types": [{}],"id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602","remote_id": "9579977"}
/custom-object-classes/{source_class_id}/custom-objects/{source_object_id}/associations/{target_class_id}/{target_object_id}/{association_type_id}
CLOSED BETACreates an Association between source_object_id
and target_object_id
of type association_type_id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
association_type_id
Stringis_debug_mode
Booleanrun_async
Booleansource_class_id
Stringsource_object_id
Stringtarget_class_id
Stringtarget_object_id
String{"source_object": "a8f5d29f-4e50-473f-8f12-27128ffcd37a","target_object": "da0b1963-be70-469c-9f8c-06a81d0fe759","association_type": "88a71b5c-a3cc-4bce-84ff-d18b049a4081"}
/custom-object-classes/generator/{generator_id}
CLOSED BETAUpdates a CustomObjectClass
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
generator_id
Stringis_debug_mode
Booleanrun_async
Boolean{"name": "order","description": "Order object","labels": {"singular": "Order","plural": "Orders"},"fields": [{"display_name": "Order ID","remote_key_name": "order_id","description": "The unique ID for the order.","is_required": true,"is_nested_list": false,"field_type": "string","field_format": null,"field_choices": [],"item_schema": null},{"display_name": "Order Quantity","remote_key_name": "order_quantity","description": "The number of items ordered.","is_required": true,"is_nested_list": false,"field_type": "number","field_format": null,"field_choices": [],"item_schema": null},{"display_name": "Customer Type","remote_key_name": "customer_type","description": "The type of customer.","is_required": true,"is_nested_list": false,"field_type": "string","field_format": null,"field_choices": ["New","Returning"],"item_schema": null}],"association_types": [{}],"id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602","remote_id": "9579977"}