Skip to main content
PATCH
Update Workspace

Authorizations

Authorization
string
header
required

Organization API key (clo_...). The X-API-Key header is also accepted in place of Authorization: Bearer.

Path Parameters

tenantID
string
required

The workspace's id, or the externalId you gave it. An id that is not one of your workspaces answers 404.

Maximum string length: 200

Body

application/json

Send only the fields to change. A field left out is kept.

name
string

The new name. It cannot be empty.

Example:

"Acme Europe"

externalId
string

The new external id. An empty string removes it.

Example:

"client-1234-eu"

Response

The workspace, as it is now.

success
boolean
required
Example:

true

data
object
required

A workspace of your organization.