Update tenant

PUT

/v1/tenants/{id}

curl --request PUT \
  --url https://example.com/v1/tenants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --data '{ "name": "example", "owner_email": "example", "owner_user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "locale": "example", "sso_start_url": "example", "sso_region": "example" }'

Authorizations

• ApiKeyAuth
• BearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Header Parameters

X-Tenant-ID

required

string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

Request Body ^required

Media type application/json

object

name

string

owner_email

Email address of the tenant owner (read-only; updated automatically on owner transfer).

string

nullable

owner_user_id

Set to transfer ownership to a different admin user in this tenant.

string format: uuid

nullable

locale

Default locale for the tenant.

string

sso_start_url

AWS IAM Identity Center start URL for SSO login.

string

nullable

sso_region

AWS region of the IAM Identity Center instance.

string

nullable

Example ^generated

{
  "name": "example",
  "owner_email": "example",
  "owner_user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "locale": "example",
  "sso_start_url": "example",
  "sso_region": "example"
}

Responses

200

OK

Media type application/json

object

id

required

string format: uuid

name

required

string

slug

required

string

locale

required

Default locale for the tenant (e.g. ‘en’, ‘fr’).

string

owner_email

Email address of the tenant owner.

string

nullable

owner_user_id

UUID of the tenant’s owner user.

string format: uuid

nullable

sso_start_url

AWS IAM Identity Center start URL for SSO login.

string

nullable

sso_region

AWS region of the IAM Identity Center instance.

string

nullable

created_at

required

string format: date-time

updated_at

required

string format: date-time

is_master

required

Whether this tenant is the master (platform) tenant.

boolean

primary_domain

First verified domain for this tenant, if any.

string

nullable

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "slug": "example",
  "locale": "example",
  "owner_email": "example",
  "sso_start_url": "example",
  "sso_region": "example",
  "created_at": "2026-04-15T12:00:00Z",
  "updated_at": "2026-04-15T12:00:00Z"
}

400

Invalid input

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}

401

Unauthenticated

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}

403

Forbidden

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}

404

Not found

Media type application/json

object

code

required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string

message

required

Human-readable description of the error.

string

details

Optional additional context about the error.

object

key

additional properties

any

notices

Policy notices from determining Cedar rules, if applicable.

Array<string>

Example ^generated

{
  "code": "example",
  "message": "example",
  "details": {},
  "notices": [
    "example"
  ]
}