Skip to main content
PATCH
/
projects
/
{project_id}
Update Project
curl --request PATCH \
  --url https://api.example.com/projects/{project_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "archived": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "archived": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
project_id
string<uuid>
required

Body

application/json

Payload to rename or archive a project. All fields optional.

​
name
string | null
Required string length: 1 - 120
​
description
string | null
Maximum string length: 2000
​
archived
boolean | null

Response

Successful Response

A project as returned by the API.

​
id
string<uuid>
required
​
org_id
string<uuid>
required
​
name
string
required
​
description
string | null
required
​
archived
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required