Create a playbook
Create a version 2 playbook. New playbooks default to draft (enabled: false); set enabled: true to validate the full step graph and activate on create.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
The ordered sections of the playbook. Each section holds an ordered list of steps (send, set, ask, run, if_else, go_to). Every section and step needs a caller-generated unique ObjectId string.
Short description of the playbook (routing-facing). Required to be non-empty when enabled is true; an active playbook without one is rejected with 422.
Whether the playbook is enabled. False (the default) creates a draft; true validates the full step graph and activates the playbook.
Request an acknowledgment for this playbook on messaging platforms
even when the Agent-wide messaging acknowledgment setting
(enable_acknowledgment_messages) is off. Never suppresses.
The structured rule gating when the Agent uses this Playbook; omit or send null for no rule. An unknown variable id or a malformed rule is rejected with a 400.
Response
Short description of the playbook (routing-facing)
The ordered sections of the playbook. Each section holds an ordered list of steps (send, set, ask, run, if_else, go_to).
Request an acknowledgment for this playbook on messaging platforms
even when the Agent-wide messaging acknowledgment setting
(enable_acknowledgment_messages) is off. Never suppresses.