Upsert variables

curl --request PUT \
  --url https://services-api.talqui.chat/v1/tenants/{tenantID}/settings/variables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "variables": [
    {
      "variableKey": "<string>",
      "variableLabel": "<string>",
      "variableValue": "<string>",
      "pluginConnectionID": "<string>",
      "pluginURN": "<string>",
      "variableDescription": "<string>"
    }
  ]
}
'

import requests

url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/settings/variables"

payload = { "variables": [
        {
            "variableKey": "<string>",
            "variableLabel": "<string>",
            "variableValue": "<string>",
            "pluginConnectionID": "<string>",
            "pluginURN": "<string>",
            "variableDescription": "<string>"
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    variables: [
      {
        variableKey: '<string>',
        variableLabel: '<string>',
        variableValue: '<string>',
        pluginConnectionID: '<string>',
        pluginURN: '<string>',
        variableDescription: '<string>'
      }
    ]
  })
};

fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/settings/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://services-api.talqui.chat/v1/tenants/{tenantID}/settings/variables",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'variables' => [
        [
                'variableKey' => '<string>',
                'variableLabel' => '<string>',
                'variableValue' => '<string>',
                'pluginConnectionID' => '<string>',
                'pluginURN' => '<string>',
                'variableDescription' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://services-api.talqui.chat/v1/tenants/{tenantID}/settings/variables"

	payload := strings.NewReader("{\n  \"variables\": [\n    {\n      \"variableKey\": \"<string>\",\n      \"variableLabel\": \"<string>\",\n      \"variableValue\": \"<string>\",\n      \"pluginConnectionID\": \"<string>\",\n      \"pluginURN\": \"<string>\",\n      \"variableDescription\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <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.put("https://services-api.talqui.chat/v1/tenants/{tenantID}/settings/variables")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"variables\": [\n    {\n      \"variableKey\": \"<string>\",\n      \"variableLabel\": \"<string>\",\n      \"variableValue\": \"<string>\",\n      \"pluginConnectionID\": \"<string>\",\n      \"pluginURN\": \"<string>\",\n      \"variableDescription\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/settings/variables")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"variables\": [\n    {\n      \"variableKey\": \"<string>\",\n      \"variableLabel\": \"<string>\",\n      \"variableValue\": \"<string>\",\n      \"pluginConnectionID\": \"<string>\",\n      \"pluginURN\": \"<string>\",\n      \"variableDescription\": \"<string>\"\n    }\n  ]\n}"

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

{
  "tenantID": "<string>",
  "variables": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "tenantID": "<string>",
      "variableID": "<string>",
      "variableKey": "<string>",
      "variableLabel": "<string>",
      "variableType": "GLOBAL",
      "variableValue": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "pluginConnectionID": "<string>",
      "pluginURN": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "variableDescription": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "error": "MissingTenantIDError",
      "error_code": 1001,
      "message": "tenantID is required.",
      "statusCode": 400
    }
  ]
}

{
  "errors": [
    {
      "error": "UnauthorizedError",
      "error_code": 1003,
      "message": "You are not authorized to perform this request.",
      "statusCode": 401
    }
  ]
}

{
  "errors": [
    {
      "error": "ForbiddenError",
      "error_code": 1004,
      "message": "You do not have access to this resource.",
      "statusCode": 403
    }
  ]
}

{
  "errors": [
    {
      "error": "UnknownError",
      "error_code": 5999,
      "message": "For some unknown reason your request has not succeeded.",
      "statusCode": 500
    }
  ]
}

PUT

tenants

{tenantID}

settings

variables

Upsert variables

curl --request PUT \
  --url https://services-api.talqui.chat/v1/tenants/{tenantID}/settings/variables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "variables": [
    {
      "variableKey": "<string>",
      "variableLabel": "<string>",
      "variableValue": "<string>",
      "pluginConnectionID": "<string>",
      "pluginURN": "<string>",
      "variableDescription": "<string>"
    }
  ]
}
'

import requests

url = "https://services-api.talqui.chat/v1/tenants/{tenantID}/settings/variables"

payload = { "variables": [
        {
            "variableKey": "<string>",
            "variableLabel": "<string>",
            "variableValue": "<string>",
            "pluginConnectionID": "<string>",
            "pluginURN": "<string>",
            "variableDescription": "<string>"
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    variables: [
      {
        variableKey: '<string>',
        variableLabel: '<string>',
        variableValue: '<string>',
        pluginConnectionID: '<string>',
        pluginURN: '<string>',
        variableDescription: '<string>'
      }
    ]
  })
};

fetch('https://services-api.talqui.chat/v1/tenants/{tenantID}/settings/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://services-api.talqui.chat/v1/tenants/{tenantID}/settings/variables",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'variables' => [
        [
                'variableKey' => '<string>',
                'variableLabel' => '<string>',
                'variableValue' => '<string>',
                'pluginConnectionID' => '<string>',
                'pluginURN' => '<string>',
                'variableDescription' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://services-api.talqui.chat/v1/tenants/{tenantID}/settings/variables"

	payload := strings.NewReader("{\n  \"variables\": [\n    {\n      \"variableKey\": \"<string>\",\n      \"variableLabel\": \"<string>\",\n      \"variableValue\": \"<string>\",\n      \"pluginConnectionID\": \"<string>\",\n      \"pluginURN\": \"<string>\",\n      \"variableDescription\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <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.put("https://services-api.talqui.chat/v1/tenants/{tenantID}/settings/variables")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"variables\": [\n    {\n      \"variableKey\": \"<string>\",\n      \"variableLabel\": \"<string>\",\n      \"variableValue\": \"<string>\",\n      \"pluginConnectionID\": \"<string>\",\n      \"pluginURN\": \"<string>\",\n      \"variableDescription\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://services-api.talqui.chat/v1/tenants/{tenantID}/settings/variables")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"variables\": [\n    {\n      \"variableKey\": \"<string>\",\n      \"variableLabel\": \"<string>\",\n      \"variableValue\": \"<string>\",\n      \"pluginConnectionID\": \"<string>\",\n      \"pluginURN\": \"<string>\",\n      \"variableDescription\": \"<string>\"\n    }\n  ]\n}"

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

{
  "tenantID": "<string>",
  "variables": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "tenantID": "<string>",
      "variableID": "<string>",
      "variableKey": "<string>",
      "variableLabel": "<string>",
      "variableType": "GLOBAL",
      "variableValue": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "pluginConnectionID": "<string>",
      "pluginURN": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "variableDescription": "<string>"
    }
  ]
}

{
  "errors": [
    {
      "error": "MissingTenantIDError",
      "error_code": 1001,
      "message": "tenantID is required.",
      "statusCode": 400
    }
  ]
}

{
  "errors": [
    {
      "error": "UnauthorizedError",
      "error_code": 1003,
      "message": "You are not authorized to perform this request.",
      "statusCode": 401
    }
  ]
}

{
  "errors": [
    {
      "error": "ForbiddenError",
      "error_code": 1004,
      "message": "You do not have access to this resource.",
      "statusCode": 403
    }
  ]
}

{
  "errors": [
    {
      "error": "UnknownError",
      "error_code": 5999,
      "message": "For some unknown reason your request has not succeeded.",
      "statusCode": 500
    }
  ]
}

Authorizations

Authorization

string

header

required

Behalf of an Operator (default). A JWT issued by Talqui Core when an operator signs in, scoped to every tenant that operator belongs to. Send as Authorization: Bearer <jwt-token>.

Path Parameters

tenantID

string

required

Body

application/json

variables

object[]

required

Variables to create or update, matched by variableKey.

Minimum array length: 1

Show child attributes

Response

Response for status 200.

tenantID

string

required

The tenant these variables belong to.

variables

object[]

required

The created/updated variables.

Show child attributes

⌘I

Real Time API

Services API

Helpdesk API

Upsert variables

Authorizations

Path Parameters

Body

Response