Automation v1.2
Retrieve information on your Marketing Automation rules.
Retrieve information on your Marketing Automation rules.
A Marketing Automation rule describes an event, action and an optional delay.
eventtype
attribute and are managed through different endpoints. For example, the "subscription" eventtype
is managed through subscriptionAutomation.An event can be triggered by the action of another Marketing Automation rule. This means that powerful sequences of events and actions can take your subscribers through a journey.
Attribute | Type | Filter | Sort | Description |
---|---|---|---|---|
id | int | Yes | Yes | Unique ID of the Marketing Automation rule. |
eventtype | enum | Yes | No | Type of event that triggers this rule: "subscription", "click", "date", "open". |
name | string | Yes | Yes | Rule name. |
paused | bool | Yes | No | Whether the rule is paused. |
summary | string/null | No | No | English-language description of the rule. |
user_id | int | Yes | No | Unique ID of the user who created this rule. |
cdate | decimal | No | Yes | Creation timestamp. |
mdate | decimal | No | No | Last modification timestamp. |
Attribute | Type | Presence | Description |
---|---|---|---|
id | int | Optional | Unique ID of the Marketing Automation rule. |
eventtype | enum | Optional | Type of event that triggers this rule: "subscription", "click", "date", "open". |
name | string | Optional | Rule name. |
paused | bool | Optional | Whether the rule is paused. |
user_id | int | Optional | Unique ID of the user who created this rule. |
This method is not supported.
This method is not supported.
This method is not supported.
There are no error codes for this endpoint.
{ "id": 12345, "eventtype": "subscription", "name": "Summer Competition Confirmation Trigger", "paused": false, "summary": "As soon as possible after a subscriber is added to the list 'Summer Competition', send the subscriber the email campaign 'Summer Competition Entry Confirmation'", "user_id": 23456, "cdate": 1234966741, "mdate": 1234966741 }