Projects

Update a project

Renames a project you own or changes its description. Omitted fields are left unchanged, and an empty body changes nothing. Only the owner can update a project. Unknown body fields are rejected.

patch/api/v1/projects/{id}

Request

  • Base URL: https://your-deployment.example.com
  • URL: https://your-deployment.example.com/api/v1/projects/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

idstring required

Request body

namestring

Unique among your live projects.

descriptionstring

Example request

{
  "description": "Sources and notes for the Q4 market analysis."
}

Response

The updated project.

idstring required
namestring required
descriptionstring required
session_idsstring[] required

Sessions grouped in the project. Anyone the project is shared with can read them.

file_idsstring[] required

Files grouped in the project. Anyone the project is shared with can read them.

created_atstring nullable required

ISO 8601 timestamp.

updated_atstring nullable required

ISO 8601 timestamp.

Changes

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