Update Input Variable

Update input variable

curl --request POST \
  --url https://dev.tryunleashx.com/api/v1/global/input-variable/update \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "variable_id": 123,
  "variable_key": "<string>",
  "description": "<string>"
}
'

import requests

url = "https://dev.tryunleashx.com/api/v1/global/input-variable/update"

payload = {
    "variable_id": 123,
    "variable_key": "<string>",
    "description": "<string>"
}
headers = {
    "token": "<token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({variable_id: 123, variable_key: '<string>', description: '<string>'})
};

fetch('https://dev.tryunleashx.com/api/v1/global/input-variable/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://dev.tryunleashx.com/api/v1/global/input-variable/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'variable_id' => 123,
    'variable_key' => '<string>',
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "token: <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://dev.tryunleashx.com/api/v1/global/input-variable/update"

	payload := strings.NewReader("{\n  \"variable_id\": 123,\n  \"variable_key\": \"<string>\",\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("token", "<token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://dev.tryunleashx.com/api/v1/global/input-variable/update")
  .header("token", "<token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"variable_id\": 123,\n  \"variable_key\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dev.tryunleashx.com/api/v1/global/input-variable/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["token"] = '<token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"variable_id\": 123,\n  \"variable_key\": \"<string>\",\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "data": {
    "id": 123
  }
}

POST

input-variable

update

Update input variable

curl --request POST \
  --url https://dev.tryunleashx.com/api/v1/global/input-variable/update \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "variable_id": 123,
  "variable_key": "<string>",
  "description": "<string>"
}
'

import requests

url = "https://dev.tryunleashx.com/api/v1/global/input-variable/update"

payload = {
    "variable_id": 123,
    "variable_key": "<string>",
    "description": "<string>"
}
headers = {
    "token": "<token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({variable_id: 123, variable_key: '<string>', description: '<string>'})
};

fetch('https://dev.tryunleashx.com/api/v1/global/input-variable/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://dev.tryunleashx.com/api/v1/global/input-variable/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'variable_id' => 123,
    'variable_key' => '<string>',
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "token: <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://dev.tryunleashx.com/api/v1/global/input-variable/update"

	payload := strings.NewReader("{\n  \"variable_id\": 123,\n  \"variable_key\": \"<string>\",\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("token", "<token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://dev.tryunleashx.com/api/v1/global/input-variable/update")
  .header("token", "<token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"variable_id\": 123,\n  \"variable_key\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dev.tryunleashx.com/api/v1/global/input-variable/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["token"] = '<token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"variable_id\": 123,\n  \"variable_key\": \"<string>\",\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "data": {
    "id": 123
  }
}

Use this endpoint to update or soft-delete a User Defined input variable.

Endpoint

POST /input-variable/update Content-Type: application/json Authentication: Required (workspace auth)

Request Body

Update fields

{
  "variable_id": 57,
  "type": "amount",
  "description": "Updated description"
}

Soft-delete a variable

{
  "variable_id": 57,
  "status": 2
}

Field	Type	Required	Description
`variable_id`	number	Yes	ID of the input variable to update
`variable_key`	string	No	Accepted but ignored — the key is immutable and is never changed (see Behavior).
`type`	string	No	New data type. One of: `string`, `number`, `date`, `email`, `phone`, `name`, `amount`, `address`, `pincode`, `no_type`.
`description`	string	No	New description
`status`	number	No	`0` (inactive), `1` (active), or `2` (deleted — soft-deletes the variable)

Response

{
  "message": "Input variable updated successfully",
  "data": { "id": 57 }
}

When status: 2 is sent:

{
  "message": "Input variable deleted successfully",
  "data": { "id": 57 }
}

Behavior

Only User Defined variables can be updated — System variables always fail with System variables cannot be modified.
variable_key is accepted in the request but is immutable and never applied — renaming a key would break every audience and agent that references it.
Passing status: 2 soft-deletes the variable (STATUS is set to 2; it no longer appears in List Input Variables). Deleting is blocked while the variable is referenced by any agent or audience.
Editing type and/or description is allowed even while the variable is in use. The change is propagated into every agent flow that references the variable by key — the matching metadata_input entry’s type/data_type and description are updated in place. Audiences store variable keys only (no type/description), so they need no propagation.
Only the fields you send are applied; omitted fields are left unchanged.

Error Cases

Error	Cause
`Input variable not found`	`variable_id` is invalid, belongs to another workspace, or is already deleted
`System variables cannot be modified`	The target variable has `IS_SYSTEM = 1`
`Type must be one of: string, number, date, email, phone, name, amount, address, pincode, no_type`	`type` is not one of the allowed values
`The input variable is linked to <N> active agent(s) and/or <N> active audience(s). First remove it from the agents/audiences to delete.`	`status: 2` sent while the variable is still referenced by an agent or audience

Example cURL

curl -X POST https://www.tryunleashx.com/api/v1/global/input-variable/update \
  -H "Content-Type: application/json" \
  -H "token: <api_key>" \
  -d '{
    "variable_id": 57,
    "type": "amount",
    "description": "Updated description"
  }'

Headers

token

string

required

API token for authentication

Body

application/json

variable_id

integer

required

ID of the input variable to update

variable_key

string

Accepted but ignored - the variable key is immutable and is never changed

type

enum<string>

New data type

Available options:

string,

number,

date,

email,

phone,

name,

amount,

address,

pincode,

no_type

description

string

New description

status

enum<integer>

0=inactive, 1=active, 2=deleted (soft-deletes the variable)

Available options:

0,

1,

2

Response

Input variable updated or deleted successfully

message

string

data

object

Show child attributes

API Documentation

Phone Numbers

Voice AI

Click to Call

Call Logs

Campaigns

Audience

Segment

Input Variables

Workspaces

Users

Update Input Variable

Endpoint

Request Body

Update fields

Soft-delete a variable

Response

Behavior

Error Cases

Example cURL

Headers

Body

Response

​Endpoint

​Request Body

​Update fields

​Soft-delete a variable

​Response

​Behavior

​Error Cases

​Example cURL

Headers

Body

Response

Endpoint

Request Body

Update fields

Soft-delete a variable

Response

Behavior

Error Cases

Example cURL