Skip to main content
POST
Create a guided agent script

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
name
string
required

Human-readable script name (1–120 chars).

description
string

Author-facing description (≤ 4000 chars). Send null to clear.

channels
enum<string>[]

Digital channels this script targets. Empty or omitted ⇒ every digital channel.

Available options:
email,
web_chat,
whatsapp,
sms,
rcs,
viber,
instagram,
messenger,
line,
telegram,
apple_messages
enabled
boolean

Whether the script is active in the agent console. Defaults to true.

start_step_id
string

step_id the console starts at. Defaults to the first step when omitted.

steps
object[]

The script's step graph (≤ 500 steps). Each step has a step_id, kind (prompt | question | note | disposition), body, and optional branch options pointing to the next step_id.

Response

200

Default Response