Change Step Order - Cognigy Documentation

curl --request POST \ --url https://api-trial.cognigy.ai/new/v2.0/playbooks/{playbookId}/steps/order \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <api-key>' \ --data ' { "stepIds": [ "<string>" ] } '

{ "type": "Bad Request", "title": "Bad Request Error", "status": 400, "detail": "Validation failed. Missing payload.", "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432", "code": 1000, "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f", "details": {} }

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

Headers

enum<string>

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.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Path Parameters

playbookId

string

required

The unique identifier for the Playbook.

Required string length: 24

Pattern: ^[a-z0-9]{24}$

Body

application/json

stepIds

string[]

required

The ordered list of Playbook Step IDs. Include each Playbook Steps IDs only once.

Required string length: 24

Pattern: ^[a-z0-9]{24}$

Response

Playbook steps order successfully changed.