Promote project playbook to library

POST

/playbooks/:id/promote

POST

/playbooks/:id/promote

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

1 {
2   "playbook": {
3     "_id": "a3f1c9d2-7b4e-4f8a-9c3d-2e5b7f6a1d9e",
4     "scope": "library",
5     "templateId": null,
6     "projectId": "proj_987654321",
7     "sourceDefinitionId": "def_123456789",
8     "sourceVersion": 2.3,
9     "slug": "customer-onboarding-draft",
10     "name": "Customer Onboarding Draft",
11     "description": "Draft version of the customer onboarding playbook for library inclusion.",
12     "icon": "📘",
13     "color": "#0055cc",
14     "status": "draft",
15     "numbering": {
16       "steps": "1.1, 1.2, 1.3"
17     },
18     "startableByUsers": true,
19     "webhookEnabled": true,
20     "webhookSecret": "s3cr3tT0k3n",
21     "orchestrator": {
22       "type": "sequential",
23       "retryPolicy": "exponentialBackoff"
24     },
25     "startForm": {
26       "fields": [
27         {
28           "name": "customerName",
29           "type": "text",
30           "required": true
31         },
32         {
33           "name": "startDate",
34           "type": "date",
35           "required": true
36         }
37       ]
38     },
39     "tasks": [
40       {
41         "id": "task_001",
42         "name": "Send welcome email",
43         "type": "email"
44       }
45     ],
46     "dependencies": [
47       {
48         "taskId": "task_001",
49         "dependsOn": "task_000"
50       }
51     ],
52     "version": 1.1,
53     "archivedAt": null,
54     "briefId": "brief_456789123",
55     "createdAt": "2024-06-10T09:15:00Z",
56     "updatedAt": "2024-06-12T14:45:00Z",
57     "createdBy": "user_123abc"
58   }
59 }

Copies a project-scope playbook into the library as a new draft. Fails with 400 when the source is not project-scope, or 409 when the slug is already taken in the library.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

The promoted library playbook.

playbookobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error