Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Playbooks

Create a Playbook Step

Creates a step in a Playbook.

post/v2.0/playbooks/{playbookId}/steps

Path parameters

playbookIdstring required

The unique identifier for the Playbook.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Request body

textstring

The text of the playbook step

dataobject

The data of this playbook step

Example request

{
  "text": "hello world!"
}

Response

Playbook Step object successfully created.

textstring

The text of the playbook step

dataobject

The data of this playbook step

_idstring

Example response

{
  "text": "hello world!"
}