Actions
The Action object is used to represent an action executed within an automation.
Properties
emailsArray
Required
The marketing emails sent by this action.
messagesArray
Required
The messages sent by this action.
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 action's name.
typeEnum
Optional
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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.
remote_was_deletedBoolean
Required
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
Optional
remote_dataArray
Optional
GET
/actions

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

US
EU
APAC

Returns a list of Action 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.
remote_idString
Optional
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_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 action's name.
emailsArray
The marketing emails sent by this action.
messagesArray
The messages sent by this action.
typeEnum
The action's type. Must pass in one of the following choices: EMAIL, MESSAGE.
integration_paramsObject
linked_account_paramsObject
To 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
idUUID
Required
include_remote_dataBoolean
Optional
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.


Previous
Overview
Next Up
Automations