Withdraw or restore a tenant's service without deleting its data (superadmin)

PUT

/v1/system/orgs/{tenant_id}/status

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

• this engine

Withdraws or restores the SERVICE of one tenant without touching its data, the step between served and deleted.

Authorizations

• bearerAuth

Parameters

Path Parameters

tenant_id

required

string format: uuid

Tenant identifier (UUIDv7).

Request Body ^required

Media type application/json

object

status

required

Suspended withdraws service WITHOUT deleting anything: mutations and interactive service are refused with 423 tenant_suspended. Three things deliberately continue. (1) Authentication and the operator’s /v1/system routes, so the tenant can be explained and restored. (2) EXPORT of the tenant’s own data — /v1/audit/export and the module portability routes — because withdrawing service must not hold a customer’s data hostage; an export taken while service is withdrawn is recorded on the tenant’s own audit chain. (3) Custodial work: the chain keeps being checkpointed and stays verifiable and backup-certifiable. active restores service losslessly. Deleting a tenant is the separate, destructive DELETE /v1/system/orgs/{tenant_id}.

string

Allowed values: active suspended

Responses

200

OK

Media type application/json

object

created_at

required

string format: date-time

data_region

string

id

required

string format: uuid

name

required

string

slug

required

string

status

required

string

tenant_id

required

string format: uuid

Example ^generated

{
  "created_at": "2026-04-15T12:00:00Z",
  "data_region": "example",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "slug": "example",
  "status": "example",
  "tenant_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

400

Bad request

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

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

401

Unauthenticated

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

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

403

Forbidden

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

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

404

Not found

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

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

409

Conflict / setup required

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

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

429

Rate limited

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

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