Reschedule Playbook Run
POST/external/v1/playbook-runs/:id/reschedulePuts a late run back on schedule from now. Every step not done yet moves forward by the same amount, so that the oldest one is due now. The gaps between the steps stay as they were. A run with nothing overdue does not change.
Authentication
Requires playbooks:run permission.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Run identifier (UUID) |
Request
bash
curl --request POST \
--url "https://app.getraze.com/external/v1/playbook-runs/3ef8c1c3-c081-4187-a6aa-657fbf1a813b/reschedule" \
--header "X-API-Key: YOUR_API_KEY"javascript
const axios = require('axios');
const runId = '3ef8c1c3-c081-4187-a6aa-657fbf1a813b';
const response = await axios.post(
`https://app.getraze.com/external/v1/playbook-runs/${runId}/reschedule`,
null,
{ headers: { 'X-API-Key': 'YOUR_API_KEY' } }
);
console.log(response.data);python
import requests
run_id = '3ef8c1c3-c081-4187-a6aa-657fbf1a813b'
response = requests.post(
f'https://app.getraze.com/external/v1/playbook-runs/{run_id}/reschedule',
headers={'X-API-Key': 'YOUR_API_KEY'}
)
print(response.json())Response
json
{
"success": true,
"data": {
"id": "3ef8c1c3-c081-4187-a6aa-657fbf1a813b",
"status": "in_progress",
"is_overdue": false,
"progress": { "steps_done": 1, "steps_total": 3, "overdue_steps": 0 }
},
"rescheduled_steps": 2
}data is the full run (format of Get Playbook Run). rescheduled_steps is the number of steps that moved; 0 when nothing was overdue.
Errors
| Status | Code | Description |
|---|---|---|
| 404 | NOT_FOUND | Run not found in this account |
| 409 | CONFLICT | The run is not in progress |