Skip to main content
POST
Create a stage in a pipeline

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer cb_live_.... Create one in Settings → API Keys. See public_api.md § 3 for scopes.

Path Parameters

pipeline_id
integer
required

Body

name
string
required
Required string length: 1 - 100
position
integer
Required range: 0 <= x <= 2147483647
color
string
Required string length: 1 - 7
is_terminal
boolean
pauses_sla
boolean

Response

id
integer
required
read-only
name
string
required
Maximum string length: 100
ticket_count
string
required
read-only
notify_template_id
string | null
required
read-only

When set, moving a ticket into this stage sends this APPROVED template to the ticket's contact on WhatsApp (opted-out contacts skipped). Set via notify_template_id in the request body on stage create/PATCH; empty string or null clears it.

notify_template_name
string | null
required
read-only
notify_template_variables
object
required
read-only

Variable mapping for notify_template, keyed by component (header/body) then by 1-based placeholder index, e.g. {"body": {"1": {"source": "field", "field": "name"}, "2": {"source": "ticket", "field": "stage"}}}. source is static (literal value), field (contact field — name/phone/email/company, resolved per recipient) or ticket (id/title/type/stage/pipeline/priority/severity/assignee/outcome/created_date/due_date). Set via notify_template_variables in the request body on stage create/PATCH; {}/null/empty string clears it, and clearing notify_template_id clears this too. Anything unresolvable sends an em dash.

position
integer
Required range: 0 <= x <= 2147483647
color
string
Maximum string length: 7
is_terminal
boolean
pauses_sla
boolean