Archive project template

POST

/project-templates/:id/archive

POST

/project-templates/:id/archive

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

1 {
2   "template": {
3     "_id": "64b8f9e2a1c4d72f9e8b4567",
4     "name": "Marketing Campaign Template",
5     "description": "A project template designed for managing marketing campaigns with predefined phases and tasks.",
6     "icon": "📈",
7     "prefix": "MKT",
8     "sections": [
9       {
10         "Planning": {
11           "tasks": [
12             "Define target audience",
13             "Set campaign goals"
14           ]
15         }
16       }
17     ],
18     "useAccess": {
19       "roles": [
20         "project_manager",
21         "marketing_lead"
22       ],
23       "userIds": [
24         "user_12345",
25         "user_67890"
26       ]
27     },
28     "defaultProjectAccess": {
29       "roles": [
30         "team_member"
31       ],
32       "userIds": [
33         "user_54321"
34       ]
35     },
36     "archivedAt": "2024-06-01T10:15:30Z",
37     "createdAt": "2023-11-15T08:00:00Z",
38     "updatedAt": "2024-05-20T14:45:00Z",
39     "createdBy": "admin_user_001"
40   }
41 }

Archives a project template so it no longer appears in the default list and cannot be used to create new projects.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

The archived project template.

templateobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error