Skip to main content
POST
Create a variable

Authorizations

Authorization
string
header
required

A Phrase Platform JWT issued for Orchestrator, sent as Authorization: Bearer <JWT>. See Authentication and access for how to obtain one.

Body

application/json

Variable attributes

Attributes of the variable to create.

name
string
required

Name of the variable: letters, digits and underscores only. Must be unique among the user's variables.

Pattern: ^[A-Za-z0-9_]+$
Example:

"simonsoft_shared_secret"

value
string
required

Value of the variable. Leading and trailing whitespace is trimmed.

Minimum string length: 1
Example:

"s3cr3t-t0k3n"

is_sensitive
boolean
default:false

Store the value encrypted and never return it. Use for secrets such as API keys.

Example:

true

Response

Created

A named value owned by a user, referenced from the user's workflows as {{ @var.<name> }}.

id
integer
required

Unique identifier of the variable.

Example:

123

inserted_at
string<date-time>
required

When the variable was created.

Example:

"2026-01-15T09:30:00.000000Z"

is_readonly
boolean
required

true for a system-generated variable, such as an integration token, which can't be changed or deleted. false for a variable a user created.

Example:

false

is_sensitive
boolean
required

true when the value is a secret: it's stored encrypted and can be overwritten but never read back. false when the value is returned as is.

Example:

false

name
string
required

Name of the variable, unique per user.

Example:

"project_template_uid"

reference
string
required

Expression to use in a workflow input parameter value to insert this variable.

Example:

"{{ @var.project_template_uid }}"

updated_at
string<date-time>
required

When the variable was last changed.

Example:

"2026-01-15T09:30:00.000000Z"

value
string | null
required

Value of the variable. Always null for a sensitive variable.

Example:

"aB3dE5fG7hI9"

url
string<uri>

Direct link to the entity in the Orchestrator UI.

Example:

"https://eu.phrase.com/orchestrator/manage/variables/123/edit"