Skip to main content
POST
outreach.workflow.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
accountId
string
required

Connected account from social.accounts.list.

Required string length: 1 - 256
name
string
required

Workflow name.

Required string length: 1 - 200
platform
enum<string>
required

Conversation platform.

Available options:
whatsapp,
instagram,
facebook,
telegram,
x,
bluesky,
reddit,
tiktok
nodes
object[]
required

Workflow steps. Saved as a draft.

Required array length: 1 - 100 elements
edges
object[]
required

Connections between steps.

Maximum array length: 200
entryNodeId
string
required

First node to execute.

Required string length: 1 - 100

Response

The result

status
string
required

Created workflow is not active.

Allowed value: "draft"
ref
string

Reference to what this call created. Pass it as ref to outreach.workflow.activate.