Skip to main content
PATCH
Update variable

Path Parameters

orgId
string<uuid>
required

The organization ID

variableId
string<uuid>
required

The variable ID

Body

Fields that can be updated on an existing organization variable

name
string

Variable name in strict snake_case. Must start with a lowercase letter, contain only lowercase letters and numbers, and use single underscores between words.

Pattern: ^[a-z][a-z0-9]*(?:_[a-z0-9]+)*$
value
string

The value of the variable

type
enum<string>
Available options:
STRING,
PHONE_NUMBER
displayName
string

Human-readable display name

description
string

Description of the variable

Response

Response returned after updating a variable

success
enum<boolean>
required
Available options:
true
data
object
required

Represents an organization variable used in workflows