Skip to main content
PUT
Change the globally unique frontend path slug.

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Body

application/json
slug
string
required

New globally unique frontend path identifier. The returned activeUrl is the only canonical link after the update. Previously used slugs remain reserved for this instance but are not active aliases. After activation, another change is blocked for 30 days.

Required string length: 6 - 30
Pattern: ^[a-z][a-z0-9-]{4,28}[a-z0-9]$
Example:

"tenant-production"

acknowledgeUrlChange
enum<boolean>
required

Must be true to confirm that earlier slug links will stop resolving and another real slug change will be blocked for 30 days.

Available options:
true
Example:

true

version
number
required

Current global instance configuration version used for optimistic concurrency control.

Required range: x >= 0
Example:

12

Response

instanceId
string
required

Internal instance UUID. API authorization and backend state continue to use this identifier.

Example:

"159836b3-a831-4c8c-bb7d-c9b91b455a7c"

slug
string
required

Current frontend path identifier after the transaction commits.

Example:

"tenant-production"

previousSlug
string | null
required

Previous active slug, or null when the instance did not have one.

Example:

"tenant-stage"

activeUrl
string
required

Canonical frontend link that is active after the update. Earlier slug links are not aliases and stop resolving.

Example:

"https://app.revoengine.com/tenant-production"

slugChangedAt
string<date-time> | null
required

Timestamp when this slug became active, or null when an unchanged legacy slug has no recorded activation time.

Example:

"2026-09-18T10:00:00.000Z"

nextSlugChangeAt
string<date-time> | null
required

Earliest timestamp at which another slug change is allowed, or null when no cooldown has started.

Example:

"2026-10-18T10:00:00.000Z"

version
number
required

Global instance configuration version after the update.

Example:

13

Last modified on September 20, 2026