Sign in

v1

latestOpenAPI 3.0.32026-07-26120117318.1 KB
Automations

Create an automation

Creates a new automation for the authenticated project.

post/automations

Request body

namestring required

Human-readable name for the automation. Must be 1–255 characters.

captionstring

Optional description. Maximum 1024 characters.

status'active' | 'inactive' | 'paused' required

Initial status of the automation.

Example request

{
  "name": "Welcome Flow",
  "caption": "Sends a welcome message to new users",
  "status": "active",
  "data": {
    "type": "event",
    "platform": "iOS",
    "initiators": [
      {
        "uid": "2",
        "type": "event"
      }
    ],
    "actions": {
      "push": "nCRUE7SW",
      "screen": "qUY7JXgF"
    },
    "segments": "A0SzRbM2vmmwixbpQxtI"
  }
}

Response

Automation created successfully.

object'automation' required

Always "automation".

idstring required

Unique automation identifier.

urlstring required

Canonical API path for this automation.

namestring required

Human-readable name of the automation.

captionstring required

Optional description of the automation.

statusstring required

Lifecycle status of the automation. paused is set via PATCH /automations/{id}/status to temporarily stop an active automation without deleting it. unknown is returned as a forward-compatibility fallback and should not be written.

Example response

{
  "id": "auto-abc123",
  "url": "/v4/automations/auto-abc123",
  "name": "Welcome Flow",
  "caption": "Sends a welcome message to new users",
  "status": "active",
  "data": {
    "type": "event",
    "platform": "iOS",
    "initiators": [
      {
        "uid": "2",
        "type": "event"
      }
    ],
    "actions": {
      "push": "nCRUE7SW",
      "screen": "qUY7JXgF"
    },
    "segments": "A0SzRbM2vmmwixbpQxtI"
  }
}