Sign in
latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Projects

Update Project

Updates a project and returns it.

post/api/v1/projects/{project_id}

Path parameters

project_idstring required

String ID of the project

Example:6XGgm6PHrGgMpCFX

Request body

namestring nullable

Updated project name. Passing null or omitting this field will leave it unchanged.

descriptionstring nullable

Updated project description. Passing null or omitting this field will leave it unchanged.

is_favoriteboolean nullable

Whether the project is marked as a favorite. Passing null or omitting this field will leave it unchanged.

view_style'list' | 'board' | 'calendar'
child_orderinteger nullable

Updated position of the project in the hierarchy. Only supported for personal projects. Passing null or omitting this field will leave it unchanged.

is_collapsedboolean nullable

Whether the project is collapsed. Passing null or omitting this field will leave it unchanged.

folder_idinteger nullable

Numeric ID of the folder.

Example request

{
  "name": "Vacation Planning",
  "description": "Tasks for planning the trip.",
  "is_favorite": true,
  "child_order": 12,
  "folder_id": 1234
}

Response

Successful Response

OR

Example response

{
  "id": "6XGgm6PHrGgMpCFX",
  "can_assign_tasks": true,
  "can_comment": true,
  "child_order": 1,
  "order_key": "a0",
  "color": "charcoal",
  "creator_uid": "1234567",
  "created_at": "2025-01-15T10:30:00Z",
  "name": "Inbox",
  "updated_at": "2025-01-16T10:30:00Z",
  "view_style": "list",
  "default_order": 1,
  "description": "Tasks for the launch plan",
  "public_key": "550e8400-e29b-41d4-a716-446655440000",
  "access": {
    "configuration": {
      "hide_collaborator_details": true,
      "disable_duplication": true
    }
  },
  "role": "admin",
  "parent_id": "6XGgm6PHrGgMpCFX"
}