Update a workspace

PATCH

/v1/workspaces/{id}

curl --request PATCH \
  --url https://example.com/v1/workspaces/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "settings": {}, "status": "active" }'

• this engine

Renames a workspace, edits its settings or archives it. The slug is immutable, and the default workspace cannot be archived because it is the resolution target for an unset workspace.

Authorizations

• bearerAuth
• browserSession

Parameters

Path Parameters

id

required

string format: uuid

Resource identifier (UUIDv7).

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body ^required

Media type application/json

object

name

string

settings

object

key

additional properties

any

status

string

Allowed values: active inactive

Responses

200

OK

Media type application/json

object

created_at

required

string format: date-time

id

required

string format: uuid

is_default

required

boolean

name

required

string

parent_id

The parent workspace in the organization tree; absent on a root and for a workspace-confined caller.

string format: uuid

settings

object

key

additional properties

any

slug

required

string

/^[a-z0-9][a-z0-9-]{0,62}$/

status

required

string

Allowed values: active inactive

tenant_id

required

string format: uuid

updated_at

required

string format: date-time

version

required

integer format: int64

Example

{
  "status": "active"
}

400

Bad request

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Unauthenticated

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Forbidden

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Not found

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Conflict / setup required

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Rate limited

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}