latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Sections

Update Section

Update a section.

post/api/v1/sections/{section_id}

Path parameters

section_idstring required

String ID of the section

Example:6fFPHV272WWh3gpW

Request body

namestring nullable

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

section_orderinteger nullable

Updated position of the section in the project. Passing null or omitting this field will leave it unchanged.

is_collapsedboolean nullable

Updated collapsed state of the section. Passing null or omitting this field will leave it unchanged.

descriptionstring nullable

Updated section description. Pass null to clear the value. Omit this field to keep it unchanged.

Example request

{
  "name": "Groceries",
  "section_order": 12,
  "is_collapsed": true,
  "description": "Tasks for the launch plan"
}

Response

Successful Response

idstring required

String ID of the section.

user_idstring required

String ID of the user who owns the section.

project_idstring required

String ID of the project that contains the section.

added_atstring date-time required

Date and time when the section was created.

updated_atstring date-time nullable required

Date and time when the section was last updated, or null if unknown.

archived_atstring date-time nullable required

Date and time when the section was archived, or null if it is active.

namestring required

Section name.

descriptionstring nullable required

Section description, or null if it has none.

section_orderinteger required

Position of the section in the project.

order_keystring nullable required

Fractional-indexing order key: sections sort by comparing keys lexicographically within a project. May be null for projects not yet migrated.

is_collapsedboolean required

Whether the section is collapsed in the user's view.

is_archivedboolean required

Whether the section is archived.

is_deletedboolean required

Whether the section is deleted.

Example response

{
  "id": "6fFPHV272WWh3gpW",
  "user_id": "1234567",
  "project_id": "6XGgm6PHrGgMpCFX",
  "added_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-16T10:30:00Z",
  "archived_at": "2025-01-17T10:30:00Z",
  "name": "Groceries",
  "description": "Tasks for the launch plan",
  "section_order": 1,
  "order_key": "a1V"
}