Create a ticket
curl --request POST \
--url https://api.minidesk.ai/v1/tickets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"body": "<string>",
"requester": {
"email": "jsmith@example.com",
"name": "<string>",
"external_id": "<string>"
},
"category": "<string>",
"language": "<string>"
}
'import requests
url = "https://api.minidesk.ai/v1/tickets"
payload = {
"body": "<string>",
"requester": {
"email": "jsmith@example.com",
"name": "<string>",
"external_id": "<string>"
},
"category": "<string>",
"language": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
body: JSON.stringify('<string>'),
requester: {email: 'jsmith@example.com', name: '<string>', external_id: '<string>'},
category: '<string>',
language: '<string>'
})
};
fetch('https://api.minidesk.ai/v1/tickets', 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://api.minidesk.ai/v1/tickets",
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([
'body' => '<string>',
'requester' => [
'email' => 'jsmith@example.com',
'name' => '<string>',
'external_id' => '<string>'
],
'category' => '<string>',
'language' => '<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://api.minidesk.ai/v1/tickets"
payload := strings.NewReader("{\n \"body\": \"<string>\",\n \"requester\": {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"external_id\": \"<string>\"\n },\n \"category\": \"<string>\",\n \"language\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.minidesk.ai/v1/tickets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"body\": \"<string>\",\n \"requester\": {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"external_id\": \"<string>\"\n },\n \"category\": \"<string>\",\n \"language\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.minidesk.ai/v1/tickets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"body\": \"<string>\",\n \"requester\": {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"external_id\": \"<string>\"\n },\n \"category\": \"<string>\",\n \"language\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference": "<string>",
"status": "new",
"priority": "low",
"category": "<string>",
"source": "agent",
"language": "<string>",
"requester": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"name": "<string>",
"is_verified": true
},
"created_at": "<string>",
"updated_at": "<string>"
}{
"error": {
"code": "validation_failed",
"message": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_failed",
"message": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_failed",
"message": "<string>",
"field": "<string>"
}
}Tickets
Create a ticket
Opens a conversation. There is no subject: a ticket is described by its first message.
Supplying requester.external_id asserts that you authenticated this person, so the requester is stored verified. An email address alone is not proof and stores unverified.
Accepts an Idempotency-Key header. A repeat within 24 hours returns the original response rather than opening a second ticket.
POST
/
tickets
Create a ticket
curl --request POST \
--url https://api.minidesk.ai/v1/tickets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"body": "<string>",
"requester": {
"email": "jsmith@example.com",
"name": "<string>",
"external_id": "<string>"
},
"category": "<string>",
"language": "<string>"
}
'import requests
url = "https://api.minidesk.ai/v1/tickets"
payload = {
"body": "<string>",
"requester": {
"email": "jsmith@example.com",
"name": "<string>",
"external_id": "<string>"
},
"category": "<string>",
"language": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
body: JSON.stringify('<string>'),
requester: {email: 'jsmith@example.com', name: '<string>', external_id: '<string>'},
category: '<string>',
language: '<string>'
})
};
fetch('https://api.minidesk.ai/v1/tickets', 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://api.minidesk.ai/v1/tickets",
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([
'body' => '<string>',
'requester' => [
'email' => 'jsmith@example.com',
'name' => '<string>',
'external_id' => '<string>'
],
'category' => '<string>',
'language' => '<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://api.minidesk.ai/v1/tickets"
payload := strings.NewReader("{\n \"body\": \"<string>\",\n \"requester\": {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"external_id\": \"<string>\"\n },\n \"category\": \"<string>\",\n \"language\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.minidesk.ai/v1/tickets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"body\": \"<string>\",\n \"requester\": {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"external_id\": \"<string>\"\n },\n \"category\": \"<string>\",\n \"language\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.minidesk.ai/v1/tickets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"body\": \"<string>\",\n \"requester\": {\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"external_id\": \"<string>\"\n },\n \"category\": \"<string>\",\n \"language\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"reference": "<string>",
"status": "new",
"priority": "low",
"category": "<string>",
"source": "agent",
"language": "<string>",
"requester": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "<string>",
"name": "<string>",
"is_verified": true
},
"created_at": "<string>",
"updated_at": "<string>"
}{
"error": {
"code": "validation_failed",
"message": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_failed",
"message": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "validation_failed",
"message": "<string>",
"field": "<string>"
}
}Authorizations
An API credential from Settings → API, sent as Authorization: Bearer mdsk_api_.... Issued per workspace and shown once.
Headers
Any unique string. Replays within 24 hours return the first response.
Body
application/json
Response
The ticket was created.
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)$Available options:
new, open, pending, resolved, closed Available options:
low, normal, high, urgent Available options:
agent, widget, email, api, telegram, instagram, messenger Show child attributes
Show child attributes