Automations
The Automation object is used to represent an automation, workflow or custom event in the remote system.
Properties
actionsArray
The actions performed by this automation.
idUUID
remote_idString
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.
nameString
The automation's name.
trigger_typeEnum
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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.
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.
remote_was_deletedBoolean
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.
field_mappingsObject
remote_dataRemoteData[]
The RemoteData object
The RemoteData object is used to represent the full data pulled from the third-party API for an object.
Properties
pathString
The third-party API path that is being called.
dataAny
The data returned from the third-party for this object in its original, unnormalized format.
GET
/automations

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

US
EU
APAC

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
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_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
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.
page_sizeInteger
Optional
Number of results to return per page. The maximum limit is 100.
remote_idString
Optional
The API provider's ID for the given object.
POST
/automations

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

US
EU
APAC

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
APAC

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.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
GET
/automations/{parent_id}/recipients

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

US
EU
APAC

Returns a list of Contact objects.


Query & path parameters
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
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_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
page_sizeInteger
Optional
Number of results to return per page. The maximum limit is 100.
parent_idUUID
Required
GET
/automations/meta/post

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

US
EU
APAC

Returns metadata for MKTGAutomation POSTs.