Skip to main content
POST
Create input variable
Use this endpoint to create a new User Defined input variable in the workspace’s registry.

Endpoint

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

Request Body

Response

Behavior

  • The new variable is always created as User Defined (IS_SYSTEM = 0) and active (STATUS = 1).
  • variable_key must be unique across both the workspace’s own variables and the global System variables — a key already used by either is rejected.
  • type is normalized to lowercase and validated against the allowed list before saving.

Error Cases

Example cURL

Headers

token
string
required

API token for authentication

Body

application/json
variable_key
string
required

Unique key for the variable. Letters, numbers and underscore only, and must start with a letter or underscore.

type
enum<string>
required

Data type of the variable

Available options:
string,
number,
date,
email,
phone,
name,
amount,
address,
pincode,
no_type
description
string

Human-readable description of the variable

Response

Input variable created successfully

message
string
data
object