Update project template

PATCH

/project-templates/:id

PATCH

/project-templates/:id

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

1 {
2   "template": {
3     "_id": "64b8f9e2a1c4d23f9b7e4d12",
4     "name": "Agile Software Development",
5     "description": "A project template designed for agile software development teams, including sprints, backlogs, and retrospectives.",
6     "icon": "🛠️",
7     "prefix": "agile-dev",
8     "sections": [
9       {}
10     ],
11     "useAccess": {
12       "roles": [
13         "project_manager",
14         "developer"
15       ],
16       "userIds": [
17         "user_12345",
18         "user_67890"
19       ]
20     },
21     "defaultProjectAccess": {
22       "roles": [
23         "team_member",
24         "qa_engineer"
25       ],
26       "userIds": [
27         "user_54321",
28         "user_09876"
29       ]
30     },
31     "archivedAt": "null",
32     "createdAt": "2023-11-15T09:30:00Z",
33     "updatedAt": "2024-06-10T16:45:00Z",
34     "createdBy": "admin_001"
35   }
36 }

Updates a project template's mutable fields. The prefix is immutable and cannot be changed.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Request

This endpoint expects an object.

namestringOptional1-120 characters

descriptionstringOptional<=1000 characters

iconstringOptional1-64 characters

useAccessobjectOptional

defaultProjectAccessobjectOptional

Response

The updated project template.

templateobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error