Skip to content

Rename the tenant named by the owner's console token.

PUT
/console/tenant
curl --request PUT \
--url https://api.canopyhq.dev/console/tenant \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example" }'
Media typeapplication/json
object
name
required

Trimmed, nonempty, at most 100 characters, with no control characters.

string
Examplegenerated
{
"name": "example"
}

The tenant’s display name was saved.

Invalid name or body; parse errors identify the field and reason when available.

No valid console token.

Only an owner may rename the tenant.