Sign in

v2

latestOpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB
Spaces

Update a space

Update a space's metadata by its ID. At least one field must be provided.

Payload Requirements

  • At least one of name, description, or is_private must be provided.
  • If name is provided, it must be unique within the organization.
  • System-managed fields (id, created_at) cannot be modified.

<Note>This endpoint is in beta, read more here.</Note>

patch/v2/spaces/{space_id}

Path parameters

space_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique space identifier (base64)

Request body

namestring

Updated name of the space

descriptionstring nullable

Updated description of the space. Set to null to clear it.

is_privateboolean

Updated visibility for the space. Set to true to make the space private (visible only to members and admins), or false to make it public. When omitted, the existing visibility is preserved.

Response

A space object

idstring required

Unique identifier for the space

namestring required

Name of the space

descriptionstring required

A brief description of the space's purpose

created_atstring date-time required

Timestamp for when the space was created

is_privateboolean required

Whether the space is private. Private spaces are only visible to their members and account/org/space admins.