Creates an automation

Creates an automation from the canonical definition. The automation is created INACTIVE; nothing runs until POST /automations/{id}/activate.

Before building a definition, call GET /automations/options for the accepted trigger types, step types, data keys, enum values, and the ids you may reference (email senders, wrappers, chapters, events, funnels, agents). POST /automations/validate runs every check without writing.

Every problem is reported at once with its JSON path. Referenced ids must belong to your organization; a sender, wrapper, page, event, saved list, or chapter from another organization is refused. Names are unique (case-insensitive) within the scope; a duplicate returns 409 unless skip_duplicate_check=true.

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

Owner of the new automation. Defaults to the API key organization. Must be the key organization, one of its chapters, or one of its child organizations.

Allowed:
integer
boolean
Defaults to false

Allow a name that already exists in the scope.

Body Params

Canonical automation shape. The same object is returned by GET /automations/{id} and accepted by POST /automations. Keys not listed here (id, is_active, scope_type, scope_id, admin_url) are refused on write.

string
required

Unique (case-insensitive) within the scope. Max 200 characters.

supported_languages
array of strings | null

Language codes for message text. Defaults to the scope languages and must include the scope default language.

supported_languages
communication_settings
object | null

Quiet hours for sends: { start: "HH:MM", end: "HH:MM", days: ["mon", ...], skip_us_holidays: boolean }. Defaults to the scope settings.

goals
array of objects | null

Optional goals. Each is { type, resource, resource_ids }. GET /automations/options lists goal types.

goals
trigger_conditions
array of objects | null

Each trigger is { type, resource, ... }. GET /automations/options lists trigger types, their resource modes (any, specified) and extra keys. At most 3 triggers. Set manual_enrollment to "allow" to permit enrolling people by hand.

trigger_conditions
steps
array of objects | null
steps
Responses

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