Automations
The
Automation
object is used to represent an automation, workflow or custom event in the remote system.Properties
actions
ArrayRequired
The actions performed by this automation.
name
StringOptional
The automation's name.
trigger_type
EnumOptional
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_date
DateTime (ISO 8601)Optional
The automation's start date.
end_date
DateTime (ISO 8601)Optional
The automation's end date.
description
StringOptional
The automation’s description.
status
StringOptional
The automation's status.
automation_trigger
ObjectOptional
The trigger configuraton for the automation.
remote_was_deleted
BooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
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
field_mappings
ObjectOptional
remote_data
ArrayOptional
GET
/automations
https://api.merge.dev/api/mktg/v1/automations
US
EU
Returns a list of Automation
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.
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.
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.
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_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.name
StringThe automation's name.
trigger_type
EnumThe trigger type for running this automation. Must pass in one of the following choices:
TRIGGER_EVENT
, RECURRENCE
.start_date
DateTime (ISO 8601)The automation's start date.
end_date
DateTime (ISO 8601)The automation's end date.
description
StringThe automation’s description.
status
StringThe automation's status.
automation_trigger
ObjectThe trigger configuraton for the automation.
actions
ArrayThe actions performed by this automation.
integration_params
Objectlinked_account_params
ObjectTo 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
id
UUIDRequired
include_remote_data
BooleanOptional
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
cursor
StringOptional
The pagination cursor value.
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.
page_size
IntegerOptional
Number of results to return per page.
parent_id
UUIDRequired
GET
/automations/meta/post
https://api.merge.dev/api/mktg/v1/automations/meta/post
US
EU
Returns metadata for MKTGAutomation
POSTs.