Skip to main content
PATCH
Rename a project

Authorizations

Authorization
string
header
required

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

Path Parameters

project_id
string
required

Body

application/json
name
string
required

New display name.

Required string length: 1 - 255

Response

Successful Response

A project. render_request is populated only for view=full.

id
string
required

Unique project id.

Example:

"proj_01J8QR2K5VKDGN2T4FBM3CZYX7"

name
string
required

Display name.

Example:

"Launch teaser"

version
integer
required

Head version. Bumped on every applied ops batch.

Example:

3

workspace_id
string
required

Owning workspace id.

editor_url
string
required

Open this project in the authenticated console.

created_at
string<date-time>
required
updated_at
string<date-time>
required
summary
ProjectSummary · object
required

Compact, always-present view of the head composition.

kind
enum<string>
default:project

project, or template: a project used as a copy source.

Available options:
project,
template
source_project_id
string | null

The project or template this one was copied from.

source_kind
enum<string> | null

What the source was: project (a duplicate), template (one of your templates) or public_template (a published template from the gallery).

Available options:
project,
template,
public_template
thumbnail_url
string | null

A poster image of the head; null until one is generated.

thumbnail_version
integer | null

The head version the thumbnail shows. It is stale while this is below version.

render_request
RenderRequest · object | null

The full head composition. Present only when requested with view=full.

direction
ProjectDirection · object | null

The direction the user accepted for this project, with its computed state; null when none is recorded. Follow it when editing. Set or clear it with the set_direction op.