Skip to main content
PUT
Update Workspace

Update Workspace

Rename a workspace or change its icon.

Authentication & Scope

Requires the workspaces-write ability. The authenticated user must be an admin of the workspace.

Request

Path Parameters

Body Parameters

Example:

Response

200 OK – Returns a confirmation plus the updated workspace object.
403 Forbidden – Token lacks workspaces-write or user lacks permission.

Authorizations

Authorization
string
header
required

Personal Access Token

Path Parameters

workspaceId
number
required

Body

application/json
name
string

The name of the workspace.

Example:

"My Marketing Team"

icon
string

The emoji or icon representing the workspace.

Example:

"🚀"

settings
object

General settings for the workspace.

Response

Updated

id
number
read-only

The unique identifier for the workspace.

Example:

1

name
string

The name of the workspace.

Example:

"My Marketing Team"

icon
string

The emoji or icon representing the workspace.

Example:

"🚀"

settings
object

General settings for the workspace.