Update Global Variable

Update the value of an existing global variable by its name. Only value can be changed — to modify dataType, isSecret, or canReset, delete and recreate the variable.

Update global variable by name

patch

Update the value of an existing global variable.

checksum header is required — must match the server's current checksum for the variable. Obtain it from the Create response or GET /dev/variable/{name} → data.checksum. If it does not match, the update is rejected.

Only value can be updated through this endpoint. To change dataType, isSecret, or canReset, delete and recreate the variable.

On success: response data includes the updated variable with a new checksum — store it for any subsequent update or delete.

Canonical request body: Update/update_variable.json

Authorizations

Nected-API-KeystringRequired

Your Nected API key. Obtain from workspace settings.

Path parameters

namestringRequired

The variable name

Example: tax_rate_gst

Header parameters

Nected-BranchstringOptional

Branch name (optional)

checksumstringRequired

Current checksum of the variable — from Create or Get response

Example: a3f1b2c4d5e6f7a8b9c0d1e2f3a4b5c6

Body

Request body for updating a global variable. Only value can be changed.

valueanyRequired

New value — must match the variable's existing dataType

Example: 20

Responses

200

OK — variable updated, new checksum returned

application/json

Standard response wrapper for single-variable operations (create, get-by-name, update)

codestringOptionalExample: success

messagestringOptionalExample: Success.

400

Bad Request — checksum mismatch or validation error

application/json

500

Internal Server Error

application/json

patch/dev/variable/{name}

PATCH /dev/variable/{name} HTTP/1.1
Host: api.nected.ai
Nected-API-Key: YOUR_API_KEY
checksum: a3f1b2c4d5e6f7a8b9c0d1e2f3a4b5c6
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "value": 20
}

{
  "data": {
    "name": "tax_rate_gst",
    "dataType": "numeric",
    "value": 20,
    "isSecret": false,
    "canReset": true,
    "checksum": "f7e6d5c4b3a2f1e0d9c8b7a6f5e4d3c2",
    "updatedAt": "2026-05-31T12:00:00.000Z"
  },
  "code": "success",
  "message": "Variable updated successfully."
}

Checksum (required)

The checksum must be sent as a request header. Obtain the current checksum from:

• Create response (data.checksum), or

• Get global variable by name (data.checksum) — most reliable.

If the checksum does not match the server's current state, the update is rejected.

On success, the response returns the updated variable with a new checksum — store it before calling update or delete again.