Activate a playbook definition

POST

/playbooks/:playbookId/activate

POST

/playbooks/:playbookId/activate

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

200Successful

1 {
2   "data": {
3     "id": "pb-9f8e7d6c5b4a3",
4     "name": "Contract intake",
5     "description": "A playbook to manage the intake and review of new contracts.",
6     "status": "active",
7     "spaceTypes": [
8       "legal",
9       "sales"
10     ],
11     "tasks": [
12       {
13         "id": "task-001",
14         "title": "Review contract terms",
15         "instructions": "Carefully review all contract terms and flag any unusual clauses.",
16         "dependsOn": []
17       }
18     ],
19     "actions": [
20       {
21         "installedActionId": "action-approve-contract",
22         "preApproval": true,
23         "postApproval": true,
24         "dependsOn": [
25           "task-001"
26         ],
27         "trigger": "agent"
28       }
29     ],
30     "version": 3,
31     "createdAt": "2024-01-15T09:30:00Z",
32     "updatedAt": "2024-04-20T14:45:00Z",
33     "createdBy": "[email protected]"
34   }
35 }

Transitions the playbook identified by playbookId to active status so it can be run. Authorization: organization administrators only — other callers are rejected with 403. No request body. Response: { data: Playbook } with the updated status.

Authentication

AuthorizationBearer

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

Path parameters

playbookIdstringRequired

Response

The activated playbook definition.

dataobject