Set secret value
PUT
Set secret value

Authorizations

Authorization
string
header
required

Voiceflow bearer token

Path Parameters

secretID
string
required

Query Parameters

projectID
string
required

The ID of the project to operate on.

Body

value
string
required

The secret value to store. Write-only — it can never be read back through this API.

environmentAlias
string

The alias of the environment to write (e.g. staging). Without it the value goes to the main environment. Requires versionVariant.

versionVariant
object

Which version of the environment to write: published, the version serving live traffic, or draft, the one used when testing. Required with environmentAlias. Without environmentAlias it defaults to published, and draft writes the main environment's draft version; a project with no main environment has no draft version, so the request is then handled as if versionVariant were omitted.

Response

200 - application/json

Confirms the value was stored and names the environment version it was written to. Only when there is no environment to name, such as a project that predates environments, does the confirmation stand alone.

message
string
required

A human-readable message confirming the update.

environmentAlias
string

The alias of the environment that now serves the value (e.g. main). Omitted only when there is no environment to name: the project predates environments, or no environmentAlias was given and the project has no main environment.

versionVariant
object

Which version of that environment now serves the value: published, the version serving live traffic, or draft, the one used when testing.

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.