Unarchive playbook

POST

/playbooks/:id/unarchive

POST

/playbooks/:id/unarchive

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

1 {
2   "playbook": {
3     "_id": "a3f1c9d2-4b7e-4f9a-9c3d-2e5b7f8a1d6c",
4     "scope": "library",
5     "templateId": "tpl_987654321",
6     "projectId": "proj_123456789",
7     "sourceDefinitionId": "def_456789123",
8     "sourceVersion": 2.3,
9     "slug": "incident-response-template",
10     "name": "Incident Response Playbook",
11     "description": "A comprehensive playbook for managing security incidents effectively.",
12     "icon": "🚨",
13     "color": "#FF5733",
14     "status": "active",
15     "numbering": {
16       "section1": "1",
17       "section2": "2"
18     },
19     "startableByUsers": true,
20     "webhookEnabled": true,
21     "webhookSecret": "whsec_4f3b2a1c",
22     "orchestrator": {
23       "type": "sequential",
24       "retryPolicy": "exponentialBackoff"
25     },
26     "startForm": {
27       "fields": [
28         {
29           "name": "incident_type",
30           "type": "dropdown",
31           "options": [
32             "phishing",
33             "malware",
34             "data_breach"
35           ]
36         }
37       ]
38     },
39     "tasks": [
40       {
41         "taskId": "task_001",
42         "name": "Identify Incident",
43         "assignedTo": "security_team"
44       }
45     ],
46     "dependencies": [
47       {
48         "dependencyId": "dep_001",
49         "type": "approval"
50       }
51     ],
52     "version": 2.3,
53     "archivedAt": null,
54     "briefId": "brief_20240601",
55     "createdAt": "2023-11-15T09:30:00Z",
56     "updatedAt": "2024-06-01T12:00:00Z",
57     "createdBy": "user_7890"
58   }
59 }

Transitions an archived playbook back to active, re-validating it first. Fails with 409 when the playbook is not currently archived, or 422 when it no longer validates.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

The unarchived playbook.

playbookobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error