Update a playbook definition

PATCH

/playbooks/:playbookId

PATCH

/playbooks/:playbookId

$ curl -X PATCH https://api.cloudraker.com/playbooks/playbookId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

200Updated

1 {
2   "data": {
3     "id": "pb-9f8e7d6c5b4a3",
4     "name": "Contract intake",
5     "description": "This playbook guides the team through the contract intake process, ensuring all necessary steps are completed before approval.",
6     "status": "draft",
7     "spaceTypes": [
8       "legal",
9       "sales"
10     ],
11     "tasks": [
12       {
13         "id": "task-001",
14         "title": "Review contract details",
15         "instructions": "Carefully review the contract terms and conditions for compliance and completeness.",
16         "dependsOn": []
17       },
18       {
19         "id": "task-002",
20         "title": "Verify client information",
21         "instructions": "Confirm the client's details and contact information are accurate and up to date.",
22         "dependsOn": [
23           "task-001"
24         ]
25       }
26     ],
27     "actions": [
28       {
29         "installedActionId": "action-approve-contract",
30         "preApproval": true,
31         "postApproval": false,
32         "dependsOn": [
33           "task-002"
34         ],
35         "trigger": "agent"
36       },
37       {
38         "installedActionId": "action-notify-legal",
39         "preApproval": false,
40         "postApproval": true,
41         "dependsOn": [
42           "task-002"
43         ],
44         "trigger": "user"
45       }
46     ],
47     "version": 2,
48     "createdAt": "2024-01-15T09:30:00Z",
49     "updatedAt": "2024-04-20T14:45:00Z",
50     "createdBy": "[email protected]"
51   }
52 }

Partially updates the playbook definition identified by playbookId and bumps its version. Authorization: organization administrators only — other callers are rejected with 403. All body fields are optional: name (1-200), description (<=5000), spaceTypes (replaces the list), tasks (<=30, replaces the whole list; each { id, title, instructions?, dependsOn? (ids of tasks that must complete first) }), actions (<=20, replaces the whole list; each { installedActionId, preApproval?, postApproval?, dependsOn? (task ids only) }). Response: { data: Playbook }.

Partially updates the playbook definition identified by `playbookId` and bumps its `version`. Authorization: organization administrators only — other callers are rejected with 403. All body fields are optional: `name` (1-200), `description` (<=5000), `spaceTypes` (replaces the list), `tasks` (<=30, replaces the whole list; each `{ id, title, instructions?, dependsOn? (ids of tasks that must complete first) }`), `actions` (<=20, replaces the whole list; each `{ installedActionId, preApproval?, postApproval?, dependsOn? (task ids only) }`). Response: `{ data: Playbook }`.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

playbookIdstringRequired

Request

tasks and actions replace the whole list. Every update bumps version.

namestringOptional1-200 characters

descriptionstringOptional<=5000 characters

spaceTypeslist of stringsOptional

taskslist of objectsOptional

actionslist of objectsOptional

Response

The updated playbook definition.

dataobject