Check helpdesk slug

curl --request GET \
  --url https://plugins-api.talqui.chat/helpdesk/v1/helpdesks/check-slug

const options = {method: 'GET'};

fetch('https://plugins-api.talqui.chat/helpdesk/v1/helpdesks/check-slug', 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/helpdesks/check-slug",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://plugins-api.talqui.chat/helpdesk/v1/helpdesks/check-slug"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://plugins-api.talqui.chat/helpdesk/v1/helpdesks/check-slug")

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

request = Net::HTTP::Get.new(url)

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

{
  "available": true,
  "normalized": "<string>",
  "reason": "reserved"
}

{
  "errors": [
    {
      "error": "RequestValidationError",
      "error_code": 1002,
      "fields": [
        {
          "allowed": "<string>",
          "field": "<string>",
          "received": "<string>"
        }
      ],
      "message": "Invalid request data.",
      "statusCode": 400
    }
  ]
}

{
  "errors": [
    {
      "error": "TooManyRequestsError",
      "error_code": 1113,
      "message": "Too many requests. Please slow down and try again shortly.",
      "statusCode": 429
    }
  ]
}

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

Helpdesk

Check helpdesk slug

Previews whether a public address (helpdeskSlug) is available, applying the exact rules the save enforces: slugify() normalization, the reserved list, and the global uniqueness index. Answers per keystroke for the onboarding’s address field, so the operator never discovers a conflict only after submitting.

Not scoped by tenant — slug uniqueness is global across every help center — and read-only: checking never reserves the address.

GET

helpdesks

check-slug

Check helpdesk slug

curl --request GET \
  --url https://plugins-api.talqui.chat/helpdesk/v1/helpdesks/check-slug

const options = {method: 'GET'};

fetch('https://plugins-api.talqui.chat/helpdesk/v1/helpdesks/check-slug', 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/helpdesks/check-slug",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://plugins-api.talqui.chat/helpdesk/v1/helpdesks/check-slug"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://plugins-api.talqui.chat/helpdesk/v1/helpdesks/check-slug")

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

request = Net::HTTP::Get.new(url)

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

{
  "available": true,
  "normalized": "<string>",
  "reason": "reserved"
}

{
  "errors": [
    {
      "error": "RequestValidationError",
      "error_code": 1002,
      "fields": [
        {
          "allowed": "<string>",
          "field": "<string>",
          "received": "<string>"
        }
      ],
      "message": "Invalid request data.",
      "statusCode": 400
    }
  ]
}

{
  "errors": [
    {
      "error": "TooManyRequestsError",
      "error_code": 1113,
      "message": "Too many requests. Please slow down and try again shortly.",
      "statusCode": 429
    }
  ]
}

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

Query Parameters

slug

string

required

Required string length: 1 - 120

Response

Response for status 200.

available

boolean

required

normalized

string

required

reason

enum<string>

Available options:

reserved,

taken,

invalid

⌘I

Real Time API

Services API

Helpdesk API

Check helpdesk slug

Query Parameters

Response