Update helpdesk
curl --request PATCH \
--url https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"helpdeskDomains": [
{
"domainHostname": "<string>",
"domainCloudflareID": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
}
],
"helpdeskLocale": "<string>",
"helpdeskName": "<string>",
"helpdeskSlug": "<string>",
"helpdeskSupport": {
"chatEnabled": true,
"emailAddress": "[email protected]",
"websiteUrl": "<string>"
},
"helpdeskTheme": {
"colorHeaderBackground": "<string>",
"colorLoading": "<string>",
"colorPrimary": "<string>",
"faviconUrl": "<string>",
"headerTitle": "<string>",
"logoUrl": "<string>"
}
}
'import requests
url = "https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk"
payload = {
"helpdeskDomains": [
{
"domainHostname": "<string>",
"domainCloudflareID": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
}
],
"helpdeskLocale": "<string>",
"helpdeskName": "<string>",
"helpdeskSlug": "<string>",
"helpdeskSupport": {
"chatEnabled": True,
"emailAddress": "[email protected]",
"websiteUrl": "<string>"
},
"helpdeskTheme": {
"colorHeaderBackground": "<string>",
"colorLoading": "<string>",
"colorPrimary": "<string>",
"faviconUrl": "<string>",
"headerTitle": "<string>",
"logoUrl": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
helpdeskDomains: [
{
domainHostname: '<string>',
domainCloudflareID: '<string>',
verifiedAt: '2023-11-07T05:31:56Z'
}
],
helpdeskLocale: '<string>',
helpdeskName: '<string>',
helpdeskSlug: '<string>',
helpdeskSupport: {chatEnabled: true, emailAddress: '[email protected]', websiteUrl: '<string>'},
helpdeskTheme: {
colorHeaderBackground: '<string>',
colorLoading: '<string>',
colorPrimary: '<string>',
faviconUrl: '<string>',
headerTitle: '<string>',
logoUrl: '<string>'
}
})
};
fetch('https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk', 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://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'helpdeskDomains' => [
[
'domainHostname' => '<string>',
'domainCloudflareID' => '<string>',
'verifiedAt' => '2023-11-07T05:31:56Z'
]
],
'helpdeskLocale' => '<string>',
'helpdeskName' => '<string>',
'helpdeskSlug' => '<string>',
'helpdeskSupport' => [
'chatEnabled' => true,
'emailAddress' => '[email protected]',
'websiteUrl' => '<string>'
],
'helpdeskTheme' => [
'colorHeaderBackground' => '<string>',
'colorLoading' => '<string>',
'colorPrimary' => '<string>',
'faviconUrl' => '<string>',
'headerTitle' => '<string>',
'logoUrl' => '<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://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk"
payload := strings.NewReader("{\n \"helpdeskDomains\": [\n {\n \"domainHostname\": \"<string>\",\n \"domainCloudflareID\": \"<string>\",\n \"verifiedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"helpdeskLocale\": \"<string>\",\n \"helpdeskName\": \"<string>\",\n \"helpdeskSlug\": \"<string>\",\n \"helpdeskSupport\": {\n \"chatEnabled\": true,\n \"emailAddress\": \"[email protected]\",\n \"websiteUrl\": \"<string>\"\n },\n \"helpdeskTheme\": {\n \"colorHeaderBackground\": \"<string>\",\n \"colorLoading\": \"<string>\",\n \"colorPrimary\": \"<string>\",\n \"faviconUrl\": \"<string>\",\n \"headerTitle\": \"<string>\",\n \"logoUrl\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"helpdeskDomains\": [\n {\n \"domainHostname\": \"<string>\",\n \"domainCloudflareID\": \"<string>\",\n \"verifiedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"helpdeskLocale\": \"<string>\",\n \"helpdeskName\": \"<string>\",\n \"helpdeskSlug\": \"<string>\",\n \"helpdeskSupport\": {\n \"chatEnabled\": true,\n \"emailAddress\": \"[email protected]\",\n \"websiteUrl\": \"<string>\"\n },\n \"helpdeskTheme\": {\n \"colorHeaderBackground\": \"<string>\",\n \"colorLoading\": \"<string>\",\n \"colorPrimary\": \"<string>\",\n \"faviconUrl\": \"<string>\",\n \"headerTitle\": \"<string>\",\n \"logoUrl\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"helpdeskDomains\": [\n {\n \"domainHostname\": \"<string>\",\n \"domainCloudflareID\": \"<string>\",\n \"verifiedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"helpdeskLocale\": \"<string>\",\n \"helpdeskName\": \"<string>\",\n \"helpdeskSlug\": \"<string>\",\n \"helpdeskSupport\": {\n \"chatEnabled\": true,\n \"emailAddress\": \"[email protected]\",\n \"websiteUrl\": \"<string>\"\n },\n \"helpdeskTheme\": {\n \"colorHeaderBackground\": \"<string>\",\n \"colorLoading\": \"<string>\",\n \"colorPrimary\": \"<string>\",\n \"faviconUrl\": \"<string>\",\n \"headerTitle\": \"<string>\",\n \"logoUrl\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"helpdesk": {
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"helpdeskDomains": [
{
"domainCloudflareID": "<string>",
"domainHostname": "<string>",
"domainStatus": "pending",
"lastCheckedAt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z"
}
],
"helpdeskID": "<string>",
"helpdeskLocale": "<string>",
"helpdeskMeta": {},
"helpdeskName": "<string>",
"helpdeskSlug": "<string>",
"helpdeskStatus": "draft",
"helpdeskSupport": {
"chatEnabled": true,
"emailAddress": "<string>",
"websiteUrl": "<string>"
},
"helpdeskTheme": {
"colorHeaderBackground": "<string>",
"colorLoading": "<string>",
"colorPrimary": "<string>",
"faviconUrl": "<string>",
"headerTitle": "<string>",
"logoUrl": "<string>"
},
"pluginConnectionID": "<string>",
"pluginID": "<string>",
"tenantID": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>"
}
}{
"errors": [
{
"error": "MissingTenantIDError",
"error_code": 1001,
"message": "tenantID is required.",
"statusCode": 400
}
]
}{
"errors": [
{
"error": "HelpdeskNotFoundError",
"error_code": 1107,
"message": "No help center answers on this address.",
"statusCode": 404
}
]
}{
"errors": [
{
"error": "SlugAlreadyInUseError",
"error_code": 1110,
"message": "This slug is already in use in this help center.",
"statusCode": 409
}
]
}{
"errors": [
{
"error": "TenantNotConnectedError",
"error_code": 1000,
"message": "This tenant is not connected to the plugin.",
"statusCode": 422
}
]
}{
"errors": [
{
"error": "UnknownError",
"error_code": 5999,
"message": "For some unknown reason your request has not succeeded.",
"statusCode": 500
}
]
}Helpdesk
Update helpdesk
Saves the help center’s identity, theme, support channels and custom
domains, then drops the hostname resolution cache — the cached resolve
payload carries both the theme and the domain list, so without the
invalidation a theme change would take up to the full TTL to show up and a
removed hostname would keep answering.
PATCH
/
v1
/
tenants
/
{tenantID}
/
helpdesk
Update helpdesk
curl --request PATCH \
--url https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"helpdeskDomains": [
{
"domainHostname": "<string>",
"domainCloudflareID": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
}
],
"helpdeskLocale": "<string>",
"helpdeskName": "<string>",
"helpdeskSlug": "<string>",
"helpdeskSupport": {
"chatEnabled": true,
"emailAddress": "[email protected]",
"websiteUrl": "<string>"
},
"helpdeskTheme": {
"colorHeaderBackground": "<string>",
"colorLoading": "<string>",
"colorPrimary": "<string>",
"faviconUrl": "<string>",
"headerTitle": "<string>",
"logoUrl": "<string>"
}
}
'import requests
url = "https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk"
payload = {
"helpdeskDomains": [
{
"domainHostname": "<string>",
"domainCloudflareID": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
}
],
"helpdeskLocale": "<string>",
"helpdeskName": "<string>",
"helpdeskSlug": "<string>",
"helpdeskSupport": {
"chatEnabled": True,
"emailAddress": "[email protected]",
"websiteUrl": "<string>"
},
"helpdeskTheme": {
"colorHeaderBackground": "<string>",
"colorLoading": "<string>",
"colorPrimary": "<string>",
"faviconUrl": "<string>",
"headerTitle": "<string>",
"logoUrl": "<string>"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
helpdeskDomains: [
{
domainHostname: '<string>',
domainCloudflareID: '<string>',
verifiedAt: '2023-11-07T05:31:56Z'
}
],
helpdeskLocale: '<string>',
helpdeskName: '<string>',
helpdeskSlug: '<string>',
helpdeskSupport: {chatEnabled: true, emailAddress: '[email protected]', websiteUrl: '<string>'},
helpdeskTheme: {
colorHeaderBackground: '<string>',
colorLoading: '<string>',
colorPrimary: '<string>',
faviconUrl: '<string>',
headerTitle: '<string>',
logoUrl: '<string>'
}
})
};
fetch('https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk', 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://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'helpdeskDomains' => [
[
'domainHostname' => '<string>',
'domainCloudflareID' => '<string>',
'verifiedAt' => '2023-11-07T05:31:56Z'
]
],
'helpdeskLocale' => '<string>',
'helpdeskName' => '<string>',
'helpdeskSlug' => '<string>',
'helpdeskSupport' => [
'chatEnabled' => true,
'emailAddress' => '[email protected]',
'websiteUrl' => '<string>'
],
'helpdeskTheme' => [
'colorHeaderBackground' => '<string>',
'colorLoading' => '<string>',
'colorPrimary' => '<string>',
'faviconUrl' => '<string>',
'headerTitle' => '<string>',
'logoUrl' => '<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://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk"
payload := strings.NewReader("{\n \"helpdeskDomains\": [\n {\n \"domainHostname\": \"<string>\",\n \"domainCloudflareID\": \"<string>\",\n \"verifiedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"helpdeskLocale\": \"<string>\",\n \"helpdeskName\": \"<string>\",\n \"helpdeskSlug\": \"<string>\",\n \"helpdeskSupport\": {\n \"chatEnabled\": true,\n \"emailAddress\": \"[email protected]\",\n \"websiteUrl\": \"<string>\"\n },\n \"helpdeskTheme\": {\n \"colorHeaderBackground\": \"<string>\",\n \"colorLoading\": \"<string>\",\n \"colorPrimary\": \"<string>\",\n \"faviconUrl\": \"<string>\",\n \"headerTitle\": \"<string>\",\n \"logoUrl\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"helpdeskDomains\": [\n {\n \"domainHostname\": \"<string>\",\n \"domainCloudflareID\": \"<string>\",\n \"verifiedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"helpdeskLocale\": \"<string>\",\n \"helpdeskName\": \"<string>\",\n \"helpdeskSlug\": \"<string>\",\n \"helpdeskSupport\": {\n \"chatEnabled\": true,\n \"emailAddress\": \"[email protected]\",\n \"websiteUrl\": \"<string>\"\n },\n \"helpdeskTheme\": {\n \"colorHeaderBackground\": \"<string>\",\n \"colorLoading\": \"<string>\",\n \"colorPrimary\": \"<string>\",\n \"faviconUrl\": \"<string>\",\n \"headerTitle\": \"<string>\",\n \"logoUrl\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://plugins-api.talqui.chat/helpdesk/v1/tenants/{tenantID}/helpdesk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"helpdeskDomains\": [\n {\n \"domainHostname\": \"<string>\",\n \"domainCloudflareID\": \"<string>\",\n \"verifiedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"helpdeskLocale\": \"<string>\",\n \"helpdeskName\": \"<string>\",\n \"helpdeskSlug\": \"<string>\",\n \"helpdeskSupport\": {\n \"chatEnabled\": true,\n \"emailAddress\": \"[email protected]\",\n \"websiteUrl\": \"<string>\"\n },\n \"helpdeskTheme\": {\n \"colorHeaderBackground\": \"<string>\",\n \"colorLoading\": \"<string>\",\n \"colorPrimary\": \"<string>\",\n \"faviconUrl\": \"<string>\",\n \"headerTitle\": \"<string>\",\n \"logoUrl\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"helpdesk": {
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"helpdeskDomains": [
{
"domainCloudflareID": "<string>",
"domainHostname": "<string>",
"domainStatus": "pending",
"lastCheckedAt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z"
}
],
"helpdeskID": "<string>",
"helpdeskLocale": "<string>",
"helpdeskMeta": {},
"helpdeskName": "<string>",
"helpdeskSlug": "<string>",
"helpdeskStatus": "draft",
"helpdeskSupport": {
"chatEnabled": true,
"emailAddress": "<string>",
"websiteUrl": "<string>"
},
"helpdeskTheme": {
"colorHeaderBackground": "<string>",
"colorLoading": "<string>",
"colorPrimary": "<string>",
"faviconUrl": "<string>",
"headerTitle": "<string>",
"logoUrl": "<string>"
},
"pluginConnectionID": "<string>",
"pluginID": "<string>",
"tenantID": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>"
}
}{
"errors": [
{
"error": "MissingTenantIDError",
"error_code": 1001,
"message": "tenantID is required.",
"statusCode": 400
}
]
}{
"errors": [
{
"error": "HelpdeskNotFoundError",
"error_code": 1107,
"message": "No help center answers on this address.",
"statusCode": 404
}
]
}{
"errors": [
{
"error": "SlugAlreadyInUseError",
"error_code": 1110,
"message": "This slug is already in use in this help center.",
"statusCode": 409
}
]
}{
"errors": [
{
"error": "TenantNotConnectedError",
"error_code": 1000,
"message": "This tenant is not connected to the plugin.",
"statusCode": 422
}
]
}{
"errors": [
{
"error": "UnknownError",
"error_code": 5999,
"message": "For some unknown reason your request has not succeeded.",
"statusCode": 500
}
]
}Authorizations
operatorAuthpluginConnectionAuthpluginAuth
Behalf of an Operator. The JWT issued by Talqui Core when an operator signs in. Send as Authorization: Bearer <jwt-token>.
Path Parameters
The tenant the help center belongs to.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Body
application/json
Maximum array length:
20Show child attributes
Show child attributes
Required string length:
2 - 10Required string length:
1 - 200Required string length:
1 - 63Available options:
draft, published Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Response for status 200.
Show child attributes
Show child attributes
⌘I