## Documentation Index

Fetch the complete documentation index at: [/llms.txt](https://docs.cognigy.com/llms.txt)

Use this file to discover all available pages before exploring further.

### Change Step Order
#### Request

```http
POST /v2.0/playbooks/{playbookId}/steps/order
```

#### cURL Example

```bash
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>"
  ]
}
'
```

#### Python Example

```python
import requests

url = "https://api-trial.cognigy.ai/new/v2.0/playbooks/{playbookId}/steps/order"

payload = { "stepIds": ["<string>"] }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

#### JavaScript (Fetch) Example

```javascript
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({stepIds: ['<string>']})
};

fetch('https://api-trial.cognigy.ai/new/v2.0/playbooks/{playbookId}/steps/order', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

### Error Responses
#### Common HTTP Error Codes
- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

#### Error Message Examples

```json
{
  "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": {}
}
```

#### Authorization

**X-API-Key**  
- Type: `string`  
- Location: `header`  
- Required: Yes  
- Description: Supply the API Key in the HTTP-Header.

### Headers
**Accept**  
- Type: `enum<string>`  
- Description: 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`.

### Path Parameters
- **playbookId**  
  - Type: `string`  
  - Required: Yes  
  - Description: The unique identifier for the Playbook.  
  - Required string length: `24`  
  - Pattern: `^[a-z0-9]{24}$`

### Body Parameters
- **stepIds**  
  - Type: `string[]`  
  - Required: Yes  
  - Description: The ordered list of Playbook Step IDs. Include each Playbook Steps IDs only once.  
  - Required string length: `24`  
  - Pattern: `^[a-z0-9]{24}$`

### Response
- `204`: Playbook steps order successfully changed.

Last modified on July 8, 2026.