Start an active Automation

cURL

curl --request POST 'https://api.brightalk.ai/automation-runs' \
  --header "Authorization: Bearer $BRIGHTALK_API_KEY" \
  --header "Brightalk-Version: 2026-07-16" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: createAutomationRun-example-001" \
  --data '{"automation_id":"atm_demo_001","contact_id":"con_demo_001"}'

const response = await fetch("https://api.brightalk.ai/automation-runs", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
    "Brightalk-Version": "2026-07-16",
    "Content-Type": "application/json",
    "Idempotency-Key": "createAutomationRun-example-001",
  },
  body: JSON.stringify({"automation_id":"atm_demo_001","contact_id":"con_demo_001"}),
});
console.log(response.status, await response.json());

import os
import requests

response = requests.request(
    "POST",
    "https://api.brightalk.ai/automation-runs",
    headers={
    "Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
    "Brightalk-Version": "2026-07-16",
    "Content-Type": "application/json",
    "Idempotency-Key": "createAutomationRun-example-001",
    },
    json={"automation_id":"atm_demo_001","contact_id":"con_demo_001"},
)
print(response.status_code, response.json())

{
  "id": "run_demo_001",
  "automation_id": "atm_demo_001",
  "contact_id": "con_demo_001",
  "input": {},
  "queued_at": "2026-07-20T01:00:00Z",
  "created_at": "2026-07-20T01:00:00Z",
  "updated_at": "2026-07-20T01:00:00Z",
  "failure_code": "step_failed",
  "started_at": "2026-07-20T01:00:00Z",
  "completed_at": "2026-07-20T01:00:00Z",
  "cancelled_at": "2026-07-20T01:00:00Z"
}

POST

automation-runs

cURL

curl --request POST 'https://api.brightalk.ai/automation-runs' \
  --header "Authorization: Bearer $BRIGHTALK_API_KEY" \
  --header "Brightalk-Version: 2026-07-16" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: createAutomationRun-example-001" \
  --data '{"automation_id":"atm_demo_001","contact_id":"con_demo_001"}'

const response = await fetch("https://api.brightalk.ai/automation-runs", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
    "Brightalk-Version": "2026-07-16",
    "Content-Type": "application/json",
    "Idempotency-Key": "createAutomationRun-example-001",
  },
  body: JSON.stringify({"automation_id":"atm_demo_001","contact_id":"con_demo_001"}),
});
console.log(response.status, await response.json());

import os
import requests

response = requests.request(
    "POST",
    "https://api.brightalk.ai/automation-runs",
    headers={
    "Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
    "Brightalk-Version": "2026-07-16",
    "Content-Type": "application/json",
    "Idempotency-Key": "createAutomationRun-example-001",
    },
    json={"automation_id":"atm_demo_001","contact_id":"con_demo_001"},
)
print(response.status_code, response.json())

{
  "id": "run_demo_001",
  "automation_id": "atm_demo_001",
  "contact_id": "con_demo_001",
  "input": {},
  "queued_at": "2026-07-20T01:00:00Z",
  "created_at": "2026-07-20T01:00:00Z",
  "updated_at": "2026-07-20T01:00:00Z",
  "failure_code": "step_failed",
  "started_at": "2026-07-20T01:00:00Z",
  "completed_at": "2026-07-20T01:00:00Z",
  "cancelled_at": "2026-07-20T01:00:00Z"
}

Authorizations

Authorization

string

header

required

Use a private-beta server credential in the Authorization header.

Headers

Brightalk-Version

string

default:2026-07-16

Selects the date-based API version. Omission uses the organization’s pinned private-beta default.

Allowed value: "2026-07-16"

X-Request-Id

string

A caller-generated correlation value matching [A-Za-z0-9._:-]{1,64}. Invalid values are replaced.

Maximum string length: 64

Pattern: ^[A-Za-z0-9._:-]{1,64}$

Idempotency-Key

string

required

A nonsecret key retained for 24 hours. Reuse only for a semantically identical request.

Required string length: 1 - 255

Pattern: ^(?=.{1,255}$)[\x21-\x7e](?:[\x20-\x7e]*[\x21-\x7e])?$

Body

application/json

JSON request body. The raw encoded body is limited to 1 MiB and unknown fields are rejected.

Option 1
Option 2

automation_id

string

required

An opaque resource identifier.

Required string length: 1 - 255

Example:

"atm_demo_001"

contact_id

string

required

An opaque resource identifier.

Required string length: 1 - 255

Example:

"con_demo_001"

input

object

Only names declared by the selected Automation may be supplied. Input is limited to 32 KiB of serialized JSON and nesting depth 10. The current contract exposes no declared names, so omit input or send an empty object.

Response

Automation run accepted into the durable queue.

string

required

An opaque resource identifier.

Required string length: 1 - 255

Example:

"run_demo_001"

status

enum<string>

required

Available options:

queued,

running,

waiting,

completed,

failed,

cancelled

automation_id

string

required

An opaque resource identifier.

Required string length: 1 - 255

Example:

"atm_demo_001"

contact_id

string

required

An opaque resource identifier.

Required string length: 1 - 255

Example:

"con_demo_001"

input

object

required

queued_at

string<date-time>

required

When the run entered the durable queue.

Example:

"2026-07-20T01:00:00Z"

created_at

string<date-time>

required

When the run resource was created.

Example:

"2026-07-20T01:00:00Z"

updated_at

string<date-time>

required

When the run resource was last updated.

Example:

"2026-07-20T01:00:00Z"

failure_code

string

A stable failure classification when the run fails.

Example:

"step_failed"

started_at

string<date-time>

When execution began.

Example:

"2026-07-20T01:00:00Z"

completed_at

string<date-time>

When execution completed.

Example:

"2026-07-20T01:00:00Z"

cancelled_at

string<date-time>

When cancellation completed.

Example:

"2026-07-20T01:00:00Z"

List API-started Automation runs Retrieve an Automation run

⌘I

Get started

API fundamentals

Core concepts

Guides

Release information

API Reference

Authorizations

Headers

Body

Response