Projects

Update project

patch/v1/workspaces/{workspace_id}/projects/{project_id}

Path parameters

workspace_idstring uuid required

Id of the workspace that owns the resource.

project_idstring uuid required

Id of the project.

Headers

Idempotency-Keystring

Opaque key making this request safe to retry. The first request with a given key executes; a later request with the same key returns that first response with Idempotent-Replayed: true instead of executing again. The key covers the method, path, query, and body it was first used with; reusing it for a different request is rejected with 422. Replayable for 24 hours.

Request body

namestring nullable

descriptionstring nullable

instructionsstring nullable

archivedboolean nullable

Set true to archive, false to unarchive. Omit to leave unchanged.

Response

Successful Response

project_idstring uuid required

The project's unique identifier.

namestring required

The project's display name.

status'active' | 'archived' | 'deleted' required

object_countinteger required

Number of library objects currently linked to this project.

descriptionstring nullable

The project's long-form description, if set.

instructionsstring nullable

Project-specific instructions that guide content created within it, if set.

Changes

No recorded changes to this endpoint across all 1 revision of this API.