Create project template

POST

/project-templates

POST

/project-templates

1 curl -X POST https:/https://api/project-templates \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "Marketing Campaign Template",
6   "icon": "📊",
7   "prefix": "MKTG1"
8 }'

1 {
2   "template": {
3     "_id": "64b8f9a2e4b0c123456789ab",
4     "name": "Marketing Campaign Template",
5     "description": "A reusable template for launching marketing campaigns including timelines, tasks, and roles.",
6     "icon": "📊",
7     "prefix": "MKTG1",
8     "sections": [
9       {}
10     ],
11     "useAccess": {
12       "roles": [
13         "marketing_manager",
14         "content_creator"
15       ],
16       "userIds": [
17         "user_12345",
18         "user_67890"
19       ]
20     },
21     "defaultProjectAccess": {
22       "roles": [
23         "project_member"
24       ],
25       "userIds": [
26         "user_54321"
27       ]
28     },
29     "archivedAt": "null",
30     "createdAt": "2024-06-15T09:30:00Z",
31     "updatedAt": "2024-06-15T09:30:00Z",
32     "createdBy": "admin_user_001"
33   }
34 }

Creates a new project template for the organization.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

namestringRequired1-120 characters

iconstringRequired1-64 characters

prefixstringRequiredformat: "^[A-Za-z][A-Za-z0-9]+$"2-6 characters

descriptionstringOptional<=1000 charactersDefaults to

useAccessobjectOptionalDefaults to {"roles":[],"userIds":[]}

defaultProjectAccessobjectOptionalDefaults to {"roles":[],"userIds":[]}

Response

The created project template.

templateobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error