Update a project

PATCH

/projects/:id

PATCH

/projects/:id

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

1 {
2   "project": {
3     "_id": "proj_8f3a2c9d7b1e4a2f9c6d",
4     "number": 42,
5     "prefix": "PRJ",
6     "numberKey": "00042",
7     "name": "Marketing Campaign Q3",
8     "description": "Project to manage all marketing activities for Q3 2024, including digital ads, events, and content creation.",
9     "icon": "📈",
10     "templateId": "tmpl_5d7f9a3b2c1e4f6a8b9d",
11     "sections": [
12       {
13         "id": "sec_01",
14         "kind": "task-list",
15         "title": "Initial Planning",
16         "config": {}
17       }
18     ],
19     "access": {
20       "roles": [
21         "project_manager",
22         "marketing_lead"
23       ],
24       "userIds": [
25         "user_12345",
26         "user_67890"
27       ]
28     },
29     "status": "active",
30     "closedAt": "null",
31     "createdAt": "2024-04-01T09:00:00Z",
32     "updatedAt": "2024-05-15T16:45:00Z",
33     "createdBy": "user_12345",
34     "createdByAttribution": "Marketing Team",
35     "provisionAttempt": "success",
36     "storageBackend": {
37       "kind": "managed",
38       "credentialId": "cred_98765",
39       "rootDirectoryId": "dir_54321"
40     }
41   }
42 }

Updates a project’s editable fields. Sections are locked on template-derived projects, and the storage backend kind is immutable (409). Requires project:manage on the project.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The project id.

Request

This endpoint expects an object.

namestringOptional1-120 characters

descriptionstringOptional<=2000 characters

iconstringOptional1-64 characters

accessobjectOptional

sectionslist of objectsOptional

storageBackendobjectOptional

Response

The updated project.

projectobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error