Skip to main content
PATCH
Partially update project

Authorizations

Authorization
string
header
required

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

Headers

tenant-id
string
required

Specifies the tenant context for the request. All endpoints operate within this tenant scope.

Example:

"tnt_pfh0haxfpzowht3oi213cqos"

Path Parameters

projectId
string
required

Unique identifier of the project.

Example:

"prj_8f4d4gk1p9h2x0s7v3n5c1a9"

Body

application/json

Request body used to partially update an existing project resource.

Request body used to partially update an existing project resource.

name
string

Name of the project.

Required string length: 1 - 255
Example:

"Website Redesign"

description
string

Optional description of the project.

Maximum string length: 1024
Example:

"Revamp the corporate website for the 2025 launch."

order
integer

Order of the resource for sorting purposes.

Required range: 0 <= x <= 9007199254740991
Example:

13

Response

Default Response

Standard success response payload wrapped in a data property.

data
object
required

Project resource returned by the API.