Skip to content

Rename your tenant

Change your tenant's name: the name your users see in the console. The name is the only part of the tenant's profile you can change; its identifier, status, dates and administrative contact are reported by the platform.

Who can do it

A tenant administrator, or a platform super administrator working inside your tenant. The console shows Tenant Name as an editable field only to a person who holds the permission to update the tenant; anyone else sees the name as plain text.

Before you start

  • The new name is 1 to 255 characters, does not begin or end with a space, and separates words with single spaces.
  • No other tenant may already use the name, compared regardless of upper or lower case.
  • Names beginning with rapidapi- are reserved, and a tenant created through the RapidAPI marketplace cannot be renamed.

Steps

  1. Open Settings. The General tab opens.
  2. In the Identity zone, change Tenant Name.
  3. Select Save Changes. The button is enabled only once the trimmed name differs from the current one and is not empty.

What you see when it worked

The console shows Tenant name updated, and the page re-reads the tenant so its heading and breadcrumb carry the new name. The name in the console's own header follows at your next sign-in or page reload. The change is written to your audit log.

If it fails

What you see Cause What to do
The name is refused as already registered Another tenant uses that name, in any letter case Choose another name
The name is refused for its spacing It begins or ends with a space, has two spaces in a row, or contains a non-breaking space Retype it with single ordinary spaces
The name is refused as reserved It begins with rapidapi- Choose a name outside that prefix
The rename is refused for a marketplace tenant A RapidAPI marketplace tenant's name is its identity Keep the name
The name is shown as text, with no field to edit You do not hold the permission to update the tenant Ask a tenant administrator

The refusal is shown under the field, with what you typed still there.

Without the console

Surface How
API PATCH /api/v3/admin/tenants/{tenantId} with {"name": "<new name>"} (operation patchTenant)
  • Tenant Settings: what the screen shows and every decision you make on it.