Activate playbook

POST

/playbooks/:id/activate

POST

/playbooks/:id/activate

1 curl -X POST https:/https://api/playbooks/id/activate \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "playbook": {
3     "_id": "63f1a2b4e7a1c9d8f0b12345",
4     "scope": "library",
5     "templateId": "tpl_9876543210abcdef",
6     "projectId": "proj_1234567890abcdef",
7     "sourceDefinitionId": "def_abcdef1234567890",
8     "sourceVersion": 1.1,
9     "slug": "customer-onboarding",
10     "name": "Customer Onboarding Playbook",
11     "description": "A playbook to guide the onboarding process for new customers.",
12     "icon": "🚀",
13     "color": "#4A90E2",
14     "status": "active",
15     "numbering": {
16       "task": "T-{number}",
17       "step": "S-{number}"
18     },
19     "startableByUsers": true,
20     "webhookEnabled": true,
21     "webhookSecret": "whsec_4f3b2a1c9d8e7f6a",
22     "orchestrator": {
23       "type": "sequential",
24       "retryPolicy": "exponentialBackoff"
25     },
26     "startForm": {
27       "fields": [
28         {
29           "id": "customerName",
30           "type": "text",
31           "label": "Customer Name",
32           "required": true
33         },
34         {
35           "id": "startDate",
36           "type": "date",
37           "label": "Start Date",
38           "required": true
39         }
40       ]
41     },
42     "tasks": [
43       {
44         "id": "task1",
45         "name": "Send Welcome Email",
46         "type": "email",
47         "assignedTo": "user_1234"
48       }
49     ],
50     "dependencies": [
51       {
52         "id": "dep1",
53         "type": "approval",
54         "dependsOnTaskId": "task1"
55       }
56     ],
57     "version": 1.1,
58     "archivedAt": null,
59     "briefId": "brief_abcdef123456",
60     "createdAt": "2024-05-20T10:15:30Z",
61     "updatedAt": "2024-06-01T08:45:00Z",
62     "createdBy": "user_admin_001"
63   }
64 }

Validates a draft playbook and transitions it to active. Fails validation (422) when the definition is invalid or a document-task/form-fill binding cannot resolve.

Authentication

AuthorizationBearer

WorkOS session JWT or an organization API key, sent as Authorization: Bearer <token>.

Path parameters

idstringRequired

Response

The activated playbook.

playbookobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error