Create a new variable config
curl --request POST \
--url https://{subdomain}.nudj.cx/api/v2/admin/variables \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '
{
"name": "<string>",
"label": "<string>",
"placeholder": "<string>",
"useDefaultProfileValue": true,
"availableInQuestionBank": true,
"maxValueOccurrences": 2,
"isSingleOutputPerUser": true,
"isImmutable": true,
"prerequisiteVariableConfigIds": [
"<string>"
],
"options": [
{
"key": "<string>",
"value": "<string>"
}
],
"validationRegex": "<string>"
}
'import requests
url = "https://{subdomain}.nudj.cx/api/v2/admin/variables"
payload = {
"name": "<string>",
"label": "<string>",
"placeholder": "<string>",
"useDefaultProfileValue": True,
"availableInQuestionBank": True,
"maxValueOccurrences": 2,
"isSingleOutputPerUser": True,
"isImmutable": True,
"prerequisiteVariableConfigIds": ["<string>"],
"options": [
{
"key": "<string>",
"value": "<string>"
}
],
"validationRegex": "<string>"
}
headers = {
"x-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
label: '<string>',
placeholder: '<string>',
useDefaultProfileValue: true,
availableInQuestionBank: true,
maxValueOccurrences: 2,
isSingleOutputPerUser: true,
isImmutable: true,
prerequisiteVariableConfigIds: ['<string>'],
options: [{key: '<string>', value: '<string>'}],
validationRegex: '<string>'
})
};
fetch('https://{subdomain}.nudj.cx/api/v2/admin/variables', 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://{subdomain}.nudj.cx/api/v2/admin/variables",
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([
'name' => '<string>',
'label' => '<string>',
'placeholder' => '<string>',
'useDefaultProfileValue' => true,
'availableInQuestionBank' => true,
'maxValueOccurrences' => 2,
'isSingleOutputPerUser' => true,
'isImmutable' => true,
'prerequisiteVariableConfigIds' => [
'<string>'
],
'options' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'validationRegex' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-token: <api-key>"
],
]);
$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://{subdomain}.nudj.cx/api/v2/admin/variables"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"useDefaultProfileValue\": true,\n \"availableInQuestionBank\": true,\n \"maxValueOccurrences\": 2,\n \"isSingleOutputPerUser\": true,\n \"isImmutable\": true,\n \"prerequisiteVariableConfigIds\": [\n \"<string>\"\n ],\n \"options\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"validationRegex\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-token", "<api-key>")
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://{subdomain}.nudj.cx/api/v2/admin/variables")
.header("x-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"useDefaultProfileValue\": true,\n \"availableInQuestionBank\": true,\n \"maxValueOccurrences\": 2,\n \"isSingleOutputPerUser\": true,\n \"isImmutable\": true,\n \"prerequisiteVariableConfigIds\": [\n \"<string>\"\n ],\n \"options\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"validationRegex\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.nudj.cx/api/v2/admin/variables")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"useDefaultProfileValue\": true,\n \"availableInQuestionBank\": true,\n \"maxValueOccurrences\": 2,\n \"isSingleOutputPerUser\": true,\n \"isImmutable\": true,\n \"prerequisiteVariableConfigIds\": [\n \"<string>\"\n ],\n \"options\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"validationRegex\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"organisationId": "<string>",
"type": "form-short-text",
"name": "<string>",
"label": "<string>",
"useDefaultProfileValue": true,
"availableInQuestionBank": true,
"maxValueOccurrences": 2,
"isSingleOutputPerUser": true,
"isImmutable": true,
"createdAt": "<string>",
"createdBy": "<string>",
"placeholder": "<string>",
"prerequisiteVariableConfigIds": [
"<string>"
],
"options": [
{
"key": "<string>",
"value": "<string>"
}
],
"validationRegex": "<string>",
"validationEndpointConfig": {
"url": "<string>",
"method": "<string>",
"headers": {}
},
"updatedAt": "<string>",
"updatedBy": "<string>"
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Variable
Create a new variable config
Creates a new variable configuration for collecting user data.
POST
/
variables
Create a new variable config
curl --request POST \
--url https://{subdomain}.nudj.cx/api/v2/admin/variables \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '
{
"name": "<string>",
"label": "<string>",
"placeholder": "<string>",
"useDefaultProfileValue": true,
"availableInQuestionBank": true,
"maxValueOccurrences": 2,
"isSingleOutputPerUser": true,
"isImmutable": true,
"prerequisiteVariableConfigIds": [
"<string>"
],
"options": [
{
"key": "<string>",
"value": "<string>"
}
],
"validationRegex": "<string>"
}
'import requests
url = "https://{subdomain}.nudj.cx/api/v2/admin/variables"
payload = {
"name": "<string>",
"label": "<string>",
"placeholder": "<string>",
"useDefaultProfileValue": True,
"availableInQuestionBank": True,
"maxValueOccurrences": 2,
"isSingleOutputPerUser": True,
"isImmutable": True,
"prerequisiteVariableConfigIds": ["<string>"],
"options": [
{
"key": "<string>",
"value": "<string>"
}
],
"validationRegex": "<string>"
}
headers = {
"x-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
label: '<string>',
placeholder: '<string>',
useDefaultProfileValue: true,
availableInQuestionBank: true,
maxValueOccurrences: 2,
isSingleOutputPerUser: true,
isImmutable: true,
prerequisiteVariableConfigIds: ['<string>'],
options: [{key: '<string>', value: '<string>'}],
validationRegex: '<string>'
})
};
fetch('https://{subdomain}.nudj.cx/api/v2/admin/variables', 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://{subdomain}.nudj.cx/api/v2/admin/variables",
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([
'name' => '<string>',
'label' => '<string>',
'placeholder' => '<string>',
'useDefaultProfileValue' => true,
'availableInQuestionBank' => true,
'maxValueOccurrences' => 2,
'isSingleOutputPerUser' => true,
'isImmutable' => true,
'prerequisiteVariableConfigIds' => [
'<string>'
],
'options' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'validationRegex' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-token: <api-key>"
],
]);
$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://{subdomain}.nudj.cx/api/v2/admin/variables"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"useDefaultProfileValue\": true,\n \"availableInQuestionBank\": true,\n \"maxValueOccurrences\": 2,\n \"isSingleOutputPerUser\": true,\n \"isImmutable\": true,\n \"prerequisiteVariableConfigIds\": [\n \"<string>\"\n ],\n \"options\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"validationRegex\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-token", "<api-key>")
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://{subdomain}.nudj.cx/api/v2/admin/variables")
.header("x-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"useDefaultProfileValue\": true,\n \"availableInQuestionBank\": true,\n \"maxValueOccurrences\": 2,\n \"isSingleOutputPerUser\": true,\n \"isImmutable\": true,\n \"prerequisiteVariableConfigIds\": [\n \"<string>\"\n ],\n \"options\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"validationRegex\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{subdomain}.nudj.cx/api/v2/admin/variables")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"label\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"useDefaultProfileValue\": true,\n \"availableInQuestionBank\": true,\n \"maxValueOccurrences\": 2,\n \"isSingleOutputPerUser\": true,\n \"isImmutable\": true,\n \"prerequisiteVariableConfigIds\": [\n \"<string>\"\n ],\n \"options\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"validationRegex\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"organisationId": "<string>",
"type": "form-short-text",
"name": "<string>",
"label": "<string>",
"useDefaultProfileValue": true,
"availableInQuestionBank": true,
"maxValueOccurrences": 2,
"isSingleOutputPerUser": true,
"isImmutable": true,
"createdAt": "<string>",
"createdBy": "<string>",
"placeholder": "<string>",
"prerequisiteVariableConfigIds": [
"<string>"
],
"options": [
{
"key": "<string>",
"value": "<string>"
}
],
"validationRegex": "<string>",
"validationEndpointConfig": {
"url": "<string>",
"method": "<string>",
"headers": {}
},
"updatedAt": "<string>",
"updatedBy": "<string>"
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Body
application/json
The input required to create a variable config
Response
Successful response
A variable configuration
Was this page helpful?

