Create Process Automation

Create a Process Automation

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Open the link below to see the list of available fields for the Automation Activities array, their data type and required or optional properties.


📘

Automation schedule

schedule_time_zone

The schedule_time_zone field in Automation_Schedule accepts two reserved strings in addition to standard timezone identifiers. These activate special delivery behavior's and are stored internally differently from what you submit.

  1. same_time_sending — same as "Recipient Local Time" in the UI. When selected, the automation begins at the set time on the earliest time zone possible (UTC+14:00) so that the email is sent as closely as possible to each contact's local time. The contact's local timezone is read from their timezone column; use a numeric ±HH:MM format (e.g. -08:00) since textual formats are subject to change. If the scheduled time has already passed in a contact's timezone, the email is sent as soon as possible. If the timezone column is NULL, the client default timezone is used.
  2. send_time_optimisation — same as "Send Time Optimization" in the UI. When selected, the automation begins at the set time on the earliest timezone possible (UTC+14:00) so that the email is sent when each contact is most active. Delivery may be deferred to the following day if a contact's calculated optimal send time has already passed when the send activity runs.
Path Params
string
required

Client-specific Identification String

Body Params
string
required
Defaults to Required

Name of the Automation

string
Defaults to Optional
int32
Defaults to null

The FolderId in which the automation will be created. The default folder is the root folder(0).

string
required
Defaults to Required

The value should be "Active", "Paused" or "Stopped"

string
Defaults to Optional

User email id for sending automation succeed message.

string
Defaults to Optional

User email id sending automation failed message.

Automation_Schedule
object
required

Required

Automation_Activities
array of objects
required

Required

Automation_Activities*
string
required
Defaults to Required

The value should be "email", "import" ."refreshTable", "refreshList"

Headers
string
required
Defaults to Required

Auth_token

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json