Close a project

POST

/projects/:id/close

POST

/projects/:id/close

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

1 {
2   "project": {
3     "_id": "64b8f9e2a1c4d3f5b7e9a123",
4     "number": 42,
5     "prefix": "PRJ",
6     "numberKey": "PRJ-0042",
7     "name": "Website Redesign",
8     "description": "Project to redesign the corporate website for improved UX and mobile responsiveness.",
9     "icon": "🖥️",
10     "templateId": "tpl-9f8e7d6c5b4a3210",
11     "sections": [
12       {
13         "id": "sec-001",
14         "kind": "milestones",
15         "title": "Project Milestones",
16         "config": {
17           "showCompleted": true,
18           "highlightNext": true
19         }
20       }
21     ],
22     "access": {
23       "roles": [
24         "project_manager",
25         "designer",
26         "developer"
27       ],
28       "userIds": [
29         "user-12345",
30         "user-67890"
31       ]
32     },
33     "status": "closed",
34     "closedAt": "2024-06-10T15:45:00Z",
35     "createdAt": "2024-01-15T09:00:00Z",
36     "updatedAt": "2024-06-10T15:45:00Z",
37     "createdBy": "user-12345",
38     "createdByAttribution": "Jane Doe",
39     "provisionAttempt": null,
40     "storageBackend": {
41       "kind": "managed",
42       "credentialId": "cred-7890abcd",
43       "rootDirectoryId": "dir-4567efgh"
44     }
45   }
46 }

Marks the project as closed and stamps closedAt. Requires project:close on the project.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The project id.

Response

The closed project.

projectobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error