Automation v1.2

Retrieve information on your Marketing Automation rules.

What can I do with automation?

A Marketing Automation rule describes an event, action and an optional delay.

  • Events can be triggered by subscriptions, contact, dates and much more.
  • Each of these events are identified by the eventtype attribute and are managed through different endpoints. For example, the "subscription" eventtype is managed through subscriptionAutomation.
  • When triggered, an event will automatically respond with an action.
  • Actions include subscriptions, contact, notifications and much more.
  • You can specify when the action will execute. This can be as soon as possible, before/after a fixed period or at a specific time.

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.

GET /automation or /automation/:id

AttributeTypeFilterSortDescription
id
intYesYesUnique ID of the Marketing Automation rule.
eventtype
enumYesNoType of event that triggers this rule: "subscription", "click", "date", "open".
name
stringYesYesRule name.
paused
boolYesNoWhether the rule is paused.
summary
string/nullNoNoEnglish-language description of the rule.
user_id
intYesNoUnique ID of the user who created this rule.
cdate
decimalNoYesCreation timestamp.
mdate
decimalNoNo

Last modification timestamp.

HEAD /automation or /automation/:id

AttributeTypePresenceDescription
id
intOptionalUnique ID of the Marketing Automation rule.
eventtype
enumOptionalType of event that triggers this rule: "subscription", "click", "date", "open".
name
stringOptionalRule name.
paused
boolOptionalWhether the rule is paused.
user_id
intOptionalUnique ID of the user who created this rule.

POST /automation

This method is not supported.

PUT /automation or /automation/:id

This method is not supported.

DELETE /automation or /automation/:id

This method is not supported.

Error codes

There are no error codes for this endpoint.

Examples

JSON response

{
    "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
}