Custom Objects
The
Custom Object
record refers to an instance of a Custom Object Class.Properties
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
modified_at
DateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
object_class
UUIDOptional
fields
ObjectRequired
remote_fields
RemoteField[]Required
GET
/custom-object-classes/{custom_object_class_id}/custom-objects
Betahttps://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects
US
EU
Returns a list of CustomObject
objects.
Query & Path Parameters
created_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
custom_object_class_id
UUIDRequired
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.
include_remote_fields
BooleanOptional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
The API provider's ID for the given object.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Salesforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
remote_id
StringNot seeing an integration that you're looking for? Submit a request for it.
POST
/custom-object-classes/{custom_object_class_id}/custom-objects
Betahttps://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects
US
EU
Creates a CustomObject
object with the given values.
Query & Path Parameters
custom_object_class_id
UUIDRequired
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.
Body Parameters
model
ObjectRequired
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.fields
ObjectField support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Salesforce
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
remote_id
StringOptional
Additional POST Parameters
fields
StringRequired
request_path_params
ObjectRequired
custom_object_class_id
StringRequired
Not seeing an integration that you're looking for? Submit a request for it.
To include the correct model fields when making POST requests, use the GET /custom-object-classes/{custom_object_class_id}/custom-objects/meta/post endpoint. Learn more in our /meta guide.
GET
/custom-object-classes/{custom_object_class_id}/custom-objects/{id}
Betahttps://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects/{id}
US
EU
Returns a CustomObject
object with the given id
.
Query & Path Parameters
custom_object_class_id
UUIDRequired
id
UUIDRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_remote_fields
BooleanOptional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Salesforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
remote_id
StringNot seeing an integration that you're looking for? Submit a request for it.
GET
/custom-object-classes/{custom_object_class_id}/custom-objects/meta/post
https://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects/meta/post
US
EU
Returns metadata for CRMCustomObject
POSTs.
Query & Path Parameters
custom_object_class_id
UUIDRequired
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Salesforce
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
remote_id
StringOptional
Additional POST Parameters
fields
StringRequired
request_path_params
ObjectRequired
custom_object_class_id
StringRequired
Not seeing an integration that you're looking for? Submit a request for it.