Skip to main content
PATCH
Update an environment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Environment ID

projectId
string
required

Project ID

Body

application/json
name
string
required

Environment name.

Minimum string length: 1

Response

Environment updated

id
string
required
object
enum<string>
required
Available options:
environment
name
string | null
required
isPrimary
boolean
required
token
string | null
required

The environment's SDK token — pass it to usertour.init() to load this environment's published content. null when inTokenScope is false: an out-of-scope environment is listed for discovery, but its key is withheld (the SDK token accepts identify/track ingestion, so handing it out would let a scoped credential act on an environment it was denied).

inTokenScope
boolean
required

Whether the CURRENT credential may act on this environment. false = the environment is listed for discovery, but reads / writes / publishing targeted at it are rejected (E1029) — plan against this instead of discovering scope limits from errors.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required