Skip to main content
POST
/
automations
Create an automation
curl --request POST \
  --url https://api.qonversion.io/v4/automations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Welcome Flow",
  "caption": "Sends a welcome message to new users",
  "status": "active",
  "data": {
    "platform": "iOS",
    "initiators": [
      {
        "uid": "2",
        "type": "event"
      }
    ],
    "actions": {
      "push": "nCRUE7SW",
      "screen": "qUY7JXgF"
    },
    "segments": null
  }
}
'
{
  "object": "automation",
  "id": "auto-abc123",
  "url": "/v4/automations/auto-abc123",
  "name": "Welcome Flow",
  "caption": "Sends a welcome message to new users",
  "status": "active",
  "data": {
    "initiators": [
      {
        "uid": "2",
        "type": "event"
      }
    ],
    "actions": {
      "push": "nCRUE7SW",
      "screen": "qUY7JXgF"
    },
    "segments": "A0SzRbM2vmmwixbpQxtI",
    "type": "event",
    "platform": "iOS"
  }
}

Documentation Index

Fetch the complete documentation index at: https://documentation.qonversion.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication using the project Secret Key (prefixed with sk_, or test_sk_ for sandbox). All v4 public endpoints require the Secret Key — see Authentication. Never expose the Secret Key in client-side code.

Body

application/json
​
name
string
required

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

Required string length: 1 - 255
Example:

"Welcome Flow"

​
status
enum<string>
required

Initial status of the automation.

Available options:
active,
inactive,
paused
Example:

"active"

​
data
object
required

Automation configuration. Push and event resources are dashboard-only; this object references them by uid.

​
caption
string

Optional description. Maximum 1024 characters.

Maximum string length: 1024
Example:

"Sends a welcome message to new users"

Response

Automation created successfully.

​
object
enum<string>
required

Always "automation".

Available options:
automation
​
id
string
required

Unique automation identifier.

Example:

"auto-abc123"

​
url
string
required

Canonical API path for this automation.

Example:

"/v4/automations/auto-abc123"

​
name
string
required

Human-readable name of the automation.

Example:

"Welcome Flow"

​
caption
string
required

Optional description of the automation.

Example:

"Sends a welcome message to new users"

​
status
string
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:

"active"

​
data
object
required

Automation configuration. Push and event resources are dashboard-only; this object references them by uid.