Create template playbook

POST

/project-templates/:templateId/playbooks

POST

/project-templates/:templateId/playbooks

1 curl -X POST https:/https://api/project-templates/templateId/playbooks \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "from": "string"
6 }'

1 {
2   "playbook": {
3     "_id": "string",
4     "scope": "library",
5     "templateId": "string",
6     "projectId": "string",
7     "sourceDefinitionId": "string",
8     "sourceVersion": 1.1,
9     "slug": "string",
10     "name": "string",
11     "description": "string",
12     "icon": "string",
13     "color": "string",
14     "status": "draft",
15     "numbering": {},
16     "startableByUsers": true,
17     "webhookEnabled": true,
18     "webhookSecret": "string",
19     "orchestrator": {},
20     "startForm": {},
21     "tasks": [
22       {}
23     ],
24     "dependencies": [
25       {}
26     ],
27     "version": 1.1,
28     "archivedAt": "string",
29     "briefId": "string",
30     "createdAt": "string",
31     "updatedAt": "string",
32     "createdBy": "string"
33   }
34 }

Creates a playbook in a project template, either from a request body or by snapshotting a library playbook via { from }. Fails with 404 when the template is missing, 400 when it is archived, or 409 on a slug conflict.

Authentication

AuthorizationBearer

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

Path parameters

templateIdstringRequired

The project template id.

Request

This endpoint expects an object.

objectRequired

Response

The created template playbook.

playbookobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error