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.

Actions may be queued when triggered by the event. Queued actions will complete when a rule is paused, but are aborted when a rule is deleted.

GET /clickAutomation or /clickAutomation/:id

Attribute

Type

Filter

Sort

Description

id

int

Yes

Yes

Unique ID of the Marketing Automation rule.

actiononweekend

bool

Yes

No

Whether the rule will trigger at weekends.

actiontarget

string

No

No

Datum used by actiontype, e.g. list ID if actiontype is "addtolist".

actionhour

string/null

No

Yes

A specific time for the action to occur, format "HH:00:00".

actiontimediff

int

No

Yes

Offset, in seconds, between a matching event and an consequent action.

actiontype

enum

No

No

The kind of action to be taken upon a successful match: "addtolist", "email_autoresponder", "notify", "sms_autoresponder".

link_id

int/null

No

No

If non-null, the unique ID of the link used in the match comparison.

message_id

int/null

No

No

If non-null, the unique ID of the message for which all containing links will be used in the match comparison.

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.

Rules will be paused if an associated list (or its containing folder) is deleted.

HEAD /clickAutomation or /clickAutomation/:id

Attribute

Type

Presence

Description

id

int

Optional

Unique ID of the Marketing Automation rule.

actiononweekend

bool

Optional

Whether the rule will trigger at weekends.

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.

POST /clickAutomation

Attribute

Type

Presence

Description

actiononweekend

bool

Optional*

Whether the rule will trigger at weekends.

actiontarget

string

Required

Datum used by actiontype, e.g. list ID if actiontype is "addtolist".

actionhour

string/null

Optional**

A specific time for the action to occur, format "HH:00:00".

actiontimediff

int

Optional**

Offset, in seconds, between a matching event and an consequent action.

actiontype

enum

Required

The kind of action to be taken upon a successful match: "addtolist", "email_autoresponder", "notify", "sms_autoresponder".

link_id

int/null

Required***

If non-null, the unique ID of the link used in the match comparison.

message_id

int/null

Required***

If non-null, the unique ID of the message for which all containing links will be used in the match comparison.

name

string

Required

Rule name.

paused

bool

Optional

Whether the rule is paused.

summary

string/null

Required

English-language description of the rule.

* Required if one of actionhour or actiontimediff are set (with actiontimediff not being set to 0). If these are not set, actiononweekend will automatically default to true and cannot be explicitly set to false.

** If actiontimediff is set to 0 and actionhour is not set, when the rule is triggered, the action will be taken as soon as possible (only for certain actiontypes).

*** Only one of link_id or message_id can be set.

If actiontype is set to "addtolist", actiontimediff must be non-zero. Otherwise, the actiontimediff must be 0 or greater. If actionhour is set, actiontimediff must be 0 or divisible by 1440.

The actionhour should be set to a local time for the company's timezone.

actiononweekend can only be set to "false" if one or both of actionhour or actiontimediff are set. If neither are set, actiononweekend will implicitly be set to "true". In this scenario, it will not be permitted to set actiononweekend to "false" as the rule will be configured to run 'as soon as possible'.

Users will only be permitted to set the message_id or actiontarget (if actiontype is "email_autoresponder" or "sms_autoresponder") to a message they have access to. Users will only be permitted to set link_id to a link ID for a message they have access to.

If an email message is associated to a clickAutomation rule via a POST/PUT, either as an actiontarget for an "email_autoresponder" actiontype, or as a message_id, or by association to a link_id, that message will become non-editable.

PUT /clickAutomation or /clickAutomation/:id

Attribute

Type

Presence

Description

id

int

Required

Unique ID of the Marketing Automation rule.

actiononweekend

bool

Optional*

Whether the rule will trigger at weekends.

actiontarget

string

Optional***

Datum used by actiontype, e.g. list ID if actiontype is "addtolist".

actionhour

string/null

Optional**

A specific time for the action to occur, format "HH:00:00".

actiontimediff

int

Optional**

Offset, in seconds, between a matching event and an consequent action.

actiontype

enum

Optional***

The kind of action to be taken upon a successful match: "addtolist", "email_autoresponder", "notify", "sms_autoresponder".

link_id

int/null

Optional

If non-null, the unique ID of the link used in the match comparison.

message_id

int/null

Optional

If non-null, the unique ID of the message for which all containing links will be used in the match comparison.

name

string

Optional

Rule name.

paused

bool

Optional

Whether the rule is paused.

summary

string/null

Optional

English-language description of the rule.

* Required if one of actionhour or actiontimediff are set (with actiontimediff not being set to 0). If these are not set, actiononweekend will automatically default to true and cannot be explicitly set to false.

** If actiontimediff is set to 0 and actionhour is not set, when the rule is triggered, the action will be taken as soon as possible (only for certain actiontypes).

*** Not all actiontypes and corresponding actiontargets can be modified once set. See tip.

If the actiontype is "email_autoresponder" or "sms_autoresponder", actiontype and actiontarget cannot be modified via a PUT request.

If enabled for the company, folder restrictions will apply to this endpoint. Users will only be able to create list-related rules for lists in folders that they have access to.

If an email message is associated to a clickAutomation rule via a POST/PUT, either as an actiontarget for an "email_autoresponder" actiontype, or as a message_id, or by association to a link_id, that message will become non-editable.

DELETE /clickAutomation or /clickAutomation/:id

Attribute

Type

Presence

Description

id

int

Required

Unique ID of the Marketing Automation rule.

Deletion of rules is restricted by user. Only rules created by the user can be deleted by that user, unless they are the admin user who can delete any rules.

Error codes

If an automation rule dependent resource (usually actiontarget, but for smsAutomation it could be list_id, email_list_id or message_id) is deleted, and the associated rule is paused, this error will be given if the user then tries to unpause the rule without changing the dependent resource.