projects

Update a Project.

Partial update — omitted fields are left untouched. Admitted for the project's creator (while a member of its team and workspace) or an admin of its team, as on the web. A member who can see the project and may not edit it is refused with 403 forbidden; a project the caller cannot see is 404.

patch/projects/{id}

Request

  • Base URL: https://restivity.ai/api/v1
  • URL: https://restivity.ai/api/v1/projects/{id}
  • Auth: OAuth 2 (authorization code, authorization URL https://restivity.ai/oauth/authorize, token URL https://restivity.ai/api/oauth/token, scopes: projects:write)

Path parameters

idstring uuid required

Unique Project identifier.

Request body

namestring
descriptionstring

A project description is plain text, at most 10,000 characters: marked text (**bold**, - and 1. lists, `code`, links) or HTML is accepted and stored as its words — markers and tags removed, list items kept as - / 1. lines — so a project card shows no asterisks, backticks or tags

colorstring
is_archivedboolean
team_idstring uuid nullable
prefixstring

New project key (2–5 uppercase letters/digits, leading letter) — reissues every task code in the project (old codes keep resolving). Omit to keep the current key; a key cannot be removed (null is refused).

Response

The updated Project.

idstring uuid required
user_idstring uuid required
namestring required
descriptionstring required
colorstring required
is_archivedboolean required
team_idstring uuid nullable required
prefixstring nullable required
task_counterinteger required
created_atstring required
updated_atstring required
deleted_atstring nullable required
urlstring
scopestring
firestore_idstring nullable
team_namestring nullable
team_slugstring nullable
task_countinteger
completed_task_countinteger
overdue_task_countinteger
next_due_datestring nullable
is_agent_inboxboolean
workspace_idstring uuid nullable
workspace_short_idstring nullable
workspace_slugstring nullable
team_short_idstring nullable

Changes

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