Skip to main content
PATCH
Update a workflow variable

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Path Parameters

id
string<uuid>
required

Body

application/json
value
any

Value

description
string

Description

Maximum string length: 2000
metadata
object

Metadata

effectiveDate
string<date>

Effective Date

Response

200 - application/json

OK

name
string
required

Name

Required string length: 1 - 255
Pattern: ^[A-Z][A-Z0-9_]*$
effectiveDate
string<date>
required

Effective Date

id
string<uuid>
required
organizationId
string
required
environment
enum<string>
required
Available options:
test,
live
scope
enum<string>
required
Available options:
system,
organization
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
value
any

Value

type
enum<string>
default:string

Type

Available options:
string,
number,
boolean,
date,
timestamp
description
string

Description

Maximum string length: 2000
metadata
object

Metadata