Skip to main content
PATCH
Update workspace

Path Parameters

workspaceSlug
string
required

URL-safe workspace identifier.

Body

application/json

Request payload to update an existing workspace.

All fields are optional; only provided fields will be updated. The slug is immutable and set at creation, so it cannot be changed here.

Request payload to update an existing workspace.

All fields are optional; only provided fields will be updated. The slug is immutable and set at creation, so it cannot be changed here.

description
string

New description for the workspace (max 500 characters).

Maximum string length: 500
displayName
string

New display name for the workspace (2-32 characters).

Required string length: 2 - 32
settings
object

Replacement workspace settings (approval requirement, data-retention rules). When omitted, settings are left unchanged.

Response

Workspace response.

Workspace response.

createdAt
string<date-time>
required

Timestamp when the workspace was created.

createdBy
object
required

Account that created this workspace.

displayName
string
required

Display name of the workspace.

memberRole
required

Role of the member in the workspace.

Allowed value: "owner"
settings
object
required

Workspace settings (approval requirement, data-retention rules).

slug
string
required

URL-safe workspace identifier.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
updatedAt
string<date-time>
required

Timestamp when the workspace was last updated.

avatarUrl
string

Serve path of the workspace's avatar (logo), when set.

description
string

Description of the workspace.