Create Global Variable

Create a new global variable in your workspace. The name must be unique. On success, the response includes the full variable object with a checksum — store this for subsequent update and delete calls.

Create global variable

post

Create a new global variable in your workspace.

Required fields: name, dataType, value.

dataType must be one of: string, numeric, boolean, json. The value must match the declared type.

isSecret (default false) — when true, the value is masked in all subsequent get/list responses.

canReset (default false) — when true, the variable can be reset to its original value via the UI.

On success: the response data includes the created variable object with its checksum — store this for update and delete calls.

Canonical request body: Create/create_variable.json

Authorizations

Nected-API-KeystringRequired

Your Nected API key. Obtain from workspace settings.

Header parameters

Nected-BranchstringOptional

Branch name (optional)

Body

Request body for creating a global variable. name, dataType, and value are required. isSecret and canReset default to false.

namestringRequired

Unique variable name (alphanumeric and underscores recommended)

Example: tax_rate_gst

dataTypestring · enumRequired

Data type of the value

Example: numericPossible values:

valueanyRequired

Variable value — type must match dataType

Example: 18

isSecretbooleanOptional

Mask value in all responses (default false)

Default: false

canResetbooleanOptional

Allow resetting to original value via UI (default false)

Default: false

Responses

200

OK — variable created, includes checksum for update/delete

application/json

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

codestringOptionalExample: success

messagestringOptionalExample: Success.

400

Bad Request — validation error or duplicate name

application/json

500

Internal Server Error

application/json

post/dev/variable

POST /dev/variable HTTP/1.1
Host: api.nected.ai
Nected-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "name": "tax_rate_gst",
  "dataType": "numeric",
  "value": 18,
  "isSecret": false,
  "canReset": true
}

{
  "data": {
    "name": "tax_rate_gst",
    "dataType": "numeric",
    "value": 18,
    "isSecret": false,
    "canReset": true,
    "checksum": "a3f1b2c4d5e6f7a8b9c0d1e2f3a4b5c6",
    "createdAt": "2026-01-10T10:00:00.000Z",
    "updatedAt": "2026-01-10T10:00:00.000Z"
  },
  "code": "success",
  "message": "Variable created successfully."
}

Example request body (full JSON)

create_variable.json

110B

Open

Response (200)

{
  "data": {
    "name": "tax_rate_gst",
    "dataType": "numeric",
    "value": 18,
    "isSecret": false,
    "canReset": true,
    "checksum": "a3f1b2c4d5e6f7a8b9c0d1e2f3a4b5c6",
    "createdAt": "2026-01-10T10:00:00.000Z",
    "updatedAt": "2026-01-10T10:00:00.000Z"
  },
  "code": "success",
  "message": "Variable created successfully."
}

Use the API reference below to try the endpoint.