Set tenant handle

Set tenant handle.

POST /api/v1/settings/handle

Error

A valid request URL is required to generate request examples

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "display_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "tenant_handle": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Body

application/json

tenant_handle · string · required

Response

200

application/json

Successful Response

id · string<uuid> · required

display_name · string · required

created_at · string<date-time> · required

tenant_handle · string | null