Skip to main content
PATCH
Update a project

Authorizations

Authorization
string
header
required

Pass your API key as Authorization: Bearer sk_…. Mint a key from your dashboard's API-keys page.

Path Parameters

project_id
string<uuid>
required

Identifier of the project.

Body

application/json

Fields to change on the project. Every field is optional.

name
string | null

New display name. Omit to leave the name unchanged.

Required string length: 1 - 256
state
enum<string> | null

Target lifecycle state: archived to archive, active to unarchive. Omit to leave the state unchanged.

Available options:
active,
archived

Response

The updated project.

A project.

id
string<uuid>
required

Project id.

name
string
required

Display name.

state
enum<string>
required

Lifecycle state.

Available options:
active,
archived
archived_at
string<date-time> | null
required

When the project was archived.

created_at
string<date-time>
required

When the project was created.

updated_at
string<date-time>
required

When the project row last changed.

last_activity_at
string<date-time>
required

When the user last changed the project's content — an upload, an asset deletion, a cut, or a render being started. Background jobs finishing do not move it, and neither does renaming an asset. Projects are listed most recently active first. Accurate to about 30 seconds; intended for display and ordering.