Import library playbook into project

POST

/projects/:projectId/playbooks/from-library

POST

/projects/:projectId/playbooks/from-library

1 curl -X POST https:/https://api/projects/projectId/playbooks/from-library \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "playbookId": "pbk_9f8e7d6c5b4a3e2f1d0c"
6 }'

1 {
2   "playbook": {
3     "_id": "pbk_9f8e7d6c5b4a3e2f1d0c",
4     "scope": "project",
5     "templateId": "tmpl_123abc456def789ghi",
6     "projectId": "proj_987zyx654wvu321tsr",
7     "sourceDefinitionId": "def_456def789ghi123abc",
8     "sourceVersion": 2.3,
9     "slug": "customer-onboarding",
10     "name": "Customer Onboarding Playbook",
11     "description": "A playbook to guide the customer onboarding process efficiently.",
12     "icon": "📋",
13     "color": "#4A90E2",
14     "status": "active",
15     "numbering": {},
16     "startableByUsers": true,
17     "webhookEnabled": false,
18     "webhookSecret": "s3cr3tK3y123",
19     "orchestrator": {},
20     "startForm": {},
21     "tasks": [
22       {}
23     ],
24     "dependencies": [
25       {}
26     ],
27     "version": 2.3,
28     "archivedAt": "null",
29     "briefId": "brief_001122334455",
30     "createdAt": "2024-05-10T09:15:00Z",
31     "updatedAt": "2024-06-01T12:00:00Z",
32     "createdBy": "user_abc123xyz789"
33   }
34 }

Imports an active library playbook into a project in one call, cloning any missing object definitions into the project first. The imported playbook lands active. Fails with 404 when the source is missing or not library-scope, or 422 when the source is not active or a reference is unresolvable.

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequired

The destination project id.

Request

This endpoint expects an object.

playbookIdstringRequired>=1 character

Response

The imported project playbook.

playbookobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error