Tenants

update tenant by id.

NOTE: this does not overwrite the entire tenant record, only the properties that are passed in the body. If you want to unset an non-required value, you can pass null.

put/tenants/{tenantId}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /tenants/{tenantId}
  • Auth
    none declared

Path parameters

tenantIdstring required

Headers

x-tenant-idstring

Optional header to set the context to a specific tenant. Only needed when the --multi-tenant feature is enabled. Default value is 'default'

Request body

Response

Ok

idstring required
createdAtstring date-time required
updatedAtstring date-time
typestring required
storageVersionstring required

Example response

{
  "id": "821f9b26-ad04-4f56-89b6-e2ef9c72b36e"
}

Changes