Actions
The
Action
object is used to represent an action executed within an automation.Properties
emails
ArrayRequired
The marketing emails sent by this action.
messages
ArrayRequired
The messages sent by this action.
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_at
DateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
name
StringOptional
The action's name.
type
EnumOptional
The action's type. Possible values include:
EMAIL
, MESSAGE
. In cases where there is no clear mapping, the original value passed through will be returned.remote_was_deleted
BooleanRequired
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_mappings
ObjectOptional
remote_data
ArrayOptional
GET
/actions
https://api.merge.dev/api/mktg/v1/actions
US
EU
APAC
Returns a list of Action
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
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_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_data
BooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
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
/actions
https://api.merge.dev/api/mktg/v1/actions
US
EU
APAC
Creates an Action
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 action's name.
emails
ArrayThe marketing emails sent by this action.
messages
ArrayThe messages sent by this action.
type
EnumThe action's type. Must pass in one of the following choices:
EMAIL
, MESSAGE
.integration_params
Objectlinked_account_params
ObjectTo include the correct model fields when making POST requests, use the GET /actions/meta/post endpoint. Learn more in our /meta guide.
GET
/actions/{id}
https://api.merge.dev/api/mktg/v1/actions/{id}
US
EU
APAC
Returns an Action
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
/actions/meta/post
https://api.merge.dev/api/mktg/v1/actions/meta/post
US
EU
APAC
Returns metadata for MKTGAction
POSTs.