Automations
The Automation object is used to represent an automation, workflow or custom event in the remote system.
Properties

actionsArray
Required
The actions performed by this automation.

idUUID
Required

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

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.

nameString
Optional
The automation's name.

trigger_typeEnum
Optional
The trigger type for running this automation. Possible values include: TRIGGER_EVENT, RECURRENCE. In cases where there is no clear mapping, the original value passed through will be returned.

start_dateDateTime (ISO 8601)
Optional
The automation's start date.

end_dateDateTime (ISO 8601)
Optional
The automation's end date.

descriptionString
Optional
The automation’s description.

statusString
Optional
The automation's status.

automation_triggerObject
Optional
The trigger configuraton for the automation.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted in the third party platform.

field_mappingsObject
Optional

remote_dataArray
Optional


GET
/automations

https://api.merge.dev/api/mktg/v1/automations

US
EU

Returns a list of Automation 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.

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.

POST
/automations

https://api.merge.dev/api/mktg/v1/automations

US
EU

Creates an Automation object with the given values.


Query & Path Parameters

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.

nameString
The automation's name.

trigger_typeEnum
The trigger type for running this automation. Must pass in one of the following choices: TRIGGER_EVENT, RECURRENCE.

start_dateDateTime (ISO 8601)
The automation's start date.

end_dateDateTime (ISO 8601)
The automation's end date.

descriptionString
The automation’s description.

statusString
The automation's status.

automation_triggerObject
The trigger configuraton for the automation.

actionsArray
The actions performed by this automation.

integration_paramsObject

linked_account_paramsObject

To include the correct model fields when making POST requests, use the GET /automations/meta/post endpoint. Learn more in our /meta guide.
GET
/automations/{id}

https://api.merge.dev/api/mktg/v1/automations/{id}

US
EU

Returns an Automation object with the given id.


Query & Path Parameters

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
GET
/automations/{parent_id}/recipients

https://api.merge.dev/api/mktg/v1/automations/{parent_id}/recipients

US
EU

Returns a list of Contact objects.


Query & Path Parameters

cursorString
Optional
The pagination cursor value.

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.

page_sizeInteger
Optional
Number of results to return per page.

parent_idUUID
Required

GET
/automations/meta/post

https://api.merge.dev/api/mktg/v1/automations/meta/post

US
EU

Returns metadata for MKTGAutomation POSTs.