Clone playbook

POST

/playbooks/:id/clone

POST

/playbooks/:id/clone

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

1 {
2   "playbook": {
3     "_id": "pb_9f8e7d6c5b4a3210",
4     "scope": "library",
5     "templateId": "tpl_123abc456def",
6     "projectId": "proj_789xyz012uvw",
7     "sourceDefinitionId": "def_456ghi789jkl",
8     "sourceVersion": 1.1,
9     "slug": "customer-onboarding",
10     "name": "Customer Onboarding Process",
11     "description": "A playbook to guide the onboarding of new customers through key steps and tasks.",
12     "icon": "onboarding_icon",
13     "color": "#4A90E2",
14     "status": "draft",
15     "numbering": {},
16     "startableByUsers": true,
17     "webhookEnabled": true,
18     "webhookSecret": "whsec_4f3e2d1c0b9a8e7d6c5b4a3f2e1d0c9b",
19     "orchestrator": {},
20     "startForm": {},
21     "tasks": [
22       {}
23     ],
24     "dependencies": [
25       {}
26     ],
27     "version": 1.1,
28     "archivedAt": "null",
29     "briefId": "brief_20240601",
30     "createdAt": "2024-06-01T09:00:00Z",
31     "updatedAt": "2024-06-10T15:30:00Z",
32     "createdBy": "user_7a8b9c0d1e2f3g4h"
33   }
34 }

Duplicates a playbook as a new draft, optionally into a different scope (library/template/project). Object references are rewritten for the destination container; an unresolvable reference fails with 422.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Request

This endpoint expects an object.

scopeenumOptional

Allowed values:

projectIdstringOptional>=1 character

templateIdstringOptional>=1 character

Response

The cloned playbook.

playbookobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error