Create imported ticket

curl --request POST \
  --url https://api.helpdesk.com/v1/importedTickets \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subject": "How to reset password",
  "teamIDs": [
    "58ceb2d5-4bc9-483b-b2a9-456164431282",
    "58ceb2d5-4bc9-483b-b2a9-456164431283"
  ],
  "requester": {
    "email": "requester@email.com",
    "name": "John Client"
  },
  "tagIDs": [
    "58ceb2d5-4bc9-483b-b2a9-456164431282",
    "58ceb2d5-4bc9-483b-b2a9-456164431283"
  ],
  "assignment": {
    "team": {
      "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c"
    },
    "agent": {
      "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c"
    }
  },
  "priority": -10,
  "customFields": {
    "order-id": "1234"
  },
  "events": [],
  "transactionID": "42e113f9-9353-4e89-9f68-69b92f423b0c"
}
'

import requests

url = "https://api.helpdesk.com/v1/importedTickets"

payload = {
    "subject": "How to reset password",
    "teamIDs": ["58ceb2d5-4bc9-483b-b2a9-456164431282", "58ceb2d5-4bc9-483b-b2a9-456164431283"],
    "requester": {
        "email": "requester@email.com",
        "name": "John Client"
    },
    "tagIDs": ["58ceb2d5-4bc9-483b-b2a9-456164431282", "58ceb2d5-4bc9-483b-b2a9-456164431283"],
    "assignment": {
        "team": { "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c" },
        "agent": { "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c" }
    },
    "priority": -10,
    "customFields": { "order-id": "1234" },
    "events": [],
    "transactionID": "42e113f9-9353-4e89-9f68-69b92f423b0c"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subject: 'How to reset password',
    teamIDs: ['58ceb2d5-4bc9-483b-b2a9-456164431282', '58ceb2d5-4bc9-483b-b2a9-456164431283'],
    requester: {email: 'requester@email.com', name: 'John Client'},
    tagIDs: ['58ceb2d5-4bc9-483b-b2a9-456164431282', '58ceb2d5-4bc9-483b-b2a9-456164431283'],
    assignment: {
      team: {ID: '42e113f9-9353-4e89-9f68-69b92f423b0c'},
      agent: {ID: '42e113f9-9353-4e89-9f68-69b92f423b0c'}
    },
    priority: -10,
    customFields: {'order-id': '1234'},
    events: [],
    transactionID: '42e113f9-9353-4e89-9f68-69b92f423b0c'
  })
};

fetch('https://api.helpdesk.com/v1/importedTickets', 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.helpdesk.com/v1/importedTickets",
  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([
    'subject' => 'How to reset password',
    'teamIDs' => [
        '58ceb2d5-4bc9-483b-b2a9-456164431282',
        '58ceb2d5-4bc9-483b-b2a9-456164431283'
    ],
    'requester' => [
        'email' => 'requester@email.com',
        'name' => 'John Client'
    ],
    'tagIDs' => [
        '58ceb2d5-4bc9-483b-b2a9-456164431282',
        '58ceb2d5-4bc9-483b-b2a9-456164431283'
    ],
    'assignment' => [
        'team' => [
                'ID' => '42e113f9-9353-4e89-9f68-69b92f423b0c'
        ],
        'agent' => [
                'ID' => '42e113f9-9353-4e89-9f68-69b92f423b0c'
        ]
    ],
    'priority' => -10,
    'customFields' => [
        'order-id' => '1234'
    ],
    'events' => [
        
    ],
    'transactionID' => '42e113f9-9353-4e89-9f68-69b92f423b0c'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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.helpdesk.com/v1/importedTickets"

	payload := strings.NewReader("{\n  \"subject\": \"How to reset password\",\n  \"teamIDs\": [\n    \"58ceb2d5-4bc9-483b-b2a9-456164431282\",\n    \"58ceb2d5-4bc9-483b-b2a9-456164431283\"\n  ],\n  \"requester\": {\n    \"email\": \"requester@email.com\",\n    \"name\": \"John Client\"\n  },\n  \"tagIDs\": [\n    \"58ceb2d5-4bc9-483b-b2a9-456164431282\",\n    \"58ceb2d5-4bc9-483b-b2a9-456164431283\"\n  ],\n  \"assignment\": {\n    \"team\": {\n      \"ID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n    },\n    \"agent\": {\n      \"ID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n    }\n  },\n  \"priority\": -10,\n  \"customFields\": {\n    \"order-id\": \"1234\"\n  },\n  \"events\": [],\n  \"transactionID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.helpdesk.com/v1/importedTickets")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subject\": \"How to reset password\",\n  \"teamIDs\": [\n    \"58ceb2d5-4bc9-483b-b2a9-456164431282\",\n    \"58ceb2d5-4bc9-483b-b2a9-456164431283\"\n  ],\n  \"requester\": {\n    \"email\": \"requester@email.com\",\n    \"name\": \"John Client\"\n  },\n  \"tagIDs\": [\n    \"58ceb2d5-4bc9-483b-b2a9-456164431282\",\n    \"58ceb2d5-4bc9-483b-b2a9-456164431283\"\n  ],\n  \"assignment\": {\n    \"team\": {\n      \"ID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n    },\n    \"agent\": {\n      \"ID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n    }\n  },\n  \"priority\": -10,\n  \"customFields\": {\n    \"order-id\": \"1234\"\n  },\n  \"events\": [],\n  \"transactionID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.helpdesk.com/v1/importedTickets")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"subject\": \"How to reset password\",\n  \"teamIDs\": [\n    \"58ceb2d5-4bc9-483b-b2a9-456164431282\",\n    \"58ceb2d5-4bc9-483b-b2a9-456164431283\"\n  ],\n  \"requester\": {\n    \"email\": \"requester@email.com\",\n    \"name\": \"John Client\"\n  },\n  \"tagIDs\": [\n    \"58ceb2d5-4bc9-483b-b2a9-456164431282\",\n    \"58ceb2d5-4bc9-483b-b2a9-456164431283\"\n  ],\n  \"assignment\": {\n    \"team\": {\n      \"ID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n    },\n    \"agent\": {\n      \"ID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n    }\n  },\n  \"priority\": -10,\n  \"customFields\": {\n    \"order-id\": \"1234\"\n  },\n  \"events\": [],\n  \"transactionID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n}"

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

{
  "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c",
  "licenseID": 13381337,
  "createdAt": "2026-06-30T22:02:08.901Z",
  "createdBy": "f56caf69-3f05-4386-9567-fdc909d7ad77",
  "createdByType": "agent",
  "updatedAt": "2026-06-30T22:02:08.901Z",
  "updatedBy": "f56caf69-3f05-4386-9567-fdc909d7ad77",
  "shortID": "IIPZGJ",
  "lastMessageAt": "2026-06-30T22:02:08.901Z",
  "parentTicket": {
    "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c",
    "shortID": "IIPZGJ",
    "subject": "Parent ticket subject"
  },
  "childTickets": [
    {
      "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c",
      "shortID": "IIPZGJ",
      "subject": "Child ticket subject"
    }
  ],
  "status": "open",
  "priority": -10,
  "subject": "Ticket subject",
  "teamIDs": [
    "42e113f9-9353-4e89-9f68-69b92f423b0c"
  ],
  "requester": {
    "email": "",
    "name": ""
  },
  "cc": [
    {
      "email": "cc@email.com",
      "name": "John Client"
    }
  ],
  "tagIDs": [
    "42e113f9-9353-4e89-9f68-69b92f423b0c"
  ],
  "followers": [
    "42e113f9-9353-4e89-9f68-69b92f423b0c"
  ],
  "assignment": {
    "team": {
      "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c",
      "name": ""
    },
    "agent": {
      "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c",
      "name": ""
    }
  },
  "integration": {
    "type": "livechat",
    "referenceType": "",
    "referenceURL": "",
    "referenceID": ""
  },
  "customFields": {
    "order-id": "1234"
  },
  "ratingRequeestSent": true,
  "rating": {
    "rate": "good",
    "comment": "",
    "requestedAt": "2026-06-30T22:02:08.901Z"
  },
  "silo": "tickets",
  "spam": {
    "status": true,
    "reason": "licenseBlackList"
  },
  "source": {
    "type": "api"
  },
  "events": [
    {
      "type": "message"
    }
  ],
  "integrations": {
    "type": "livechat",
    "externalID": ""
  },
  "detectedLanguage": ""
}

Imported tickets

Create imported ticket

By default this endpoint creates a ticket without attachments. If you want to create a ticket containing attachments:

Create new import transaction by issuing POST request to /v1/importedTickets/transactions endpoint
Upload attachments by issuing POST request(s) to /v1/importedTickets/attachments with proper transactionID acquired in step 1. The response will contain array with attachmentIDs you can use in step 3.
Create new ticket issuing POST request to /v1/importedTickets endpoint with additional transactionID parameter acquired in step 1

Remarks:

First event has to be of type message
Date of first message event is considered ticket creating date
Events have to be chronologically ordered and in the past
Events of type message and attachments are grouped together when the date parameter in both events match attachment.files array contains IDs generated during attachment upload
All uploaded attachments have to be used during ticket import
TransactionID stays valid for 24 hours
Ticket status can be changed using status event (last such status is used as final status)
Agent-issued message or attachment requires agentID, agentName and isPrivate parameters. Messages without these parameters are considered as requester-issued. These rules concern both message and attachments events.

POST

importedTickets

Create imported ticket

curl --request POST \
  --url https://api.helpdesk.com/v1/importedTickets \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subject": "How to reset password",
  "teamIDs": [
    "58ceb2d5-4bc9-483b-b2a9-456164431282",
    "58ceb2d5-4bc9-483b-b2a9-456164431283"
  ],
  "requester": {
    "email": "requester@email.com",
    "name": "John Client"
  },
  "tagIDs": [
    "58ceb2d5-4bc9-483b-b2a9-456164431282",
    "58ceb2d5-4bc9-483b-b2a9-456164431283"
  ],
  "assignment": {
    "team": {
      "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c"
    },
    "agent": {
      "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c"
    }
  },
  "priority": -10,
  "customFields": {
    "order-id": "1234"
  },
  "events": [],
  "transactionID": "42e113f9-9353-4e89-9f68-69b92f423b0c"
}
'

import requests

url = "https://api.helpdesk.com/v1/importedTickets"

payload = {
    "subject": "How to reset password",
    "teamIDs": ["58ceb2d5-4bc9-483b-b2a9-456164431282", "58ceb2d5-4bc9-483b-b2a9-456164431283"],
    "requester": {
        "email": "requester@email.com",
        "name": "John Client"
    },
    "tagIDs": ["58ceb2d5-4bc9-483b-b2a9-456164431282", "58ceb2d5-4bc9-483b-b2a9-456164431283"],
    "assignment": {
        "team": { "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c" },
        "agent": { "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c" }
    },
    "priority": -10,
    "customFields": { "order-id": "1234" },
    "events": [],
    "transactionID": "42e113f9-9353-4e89-9f68-69b92f423b0c"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    subject: 'How to reset password',
    teamIDs: ['58ceb2d5-4bc9-483b-b2a9-456164431282', '58ceb2d5-4bc9-483b-b2a9-456164431283'],
    requester: {email: 'requester@email.com', name: 'John Client'},
    tagIDs: ['58ceb2d5-4bc9-483b-b2a9-456164431282', '58ceb2d5-4bc9-483b-b2a9-456164431283'],
    assignment: {
      team: {ID: '42e113f9-9353-4e89-9f68-69b92f423b0c'},
      agent: {ID: '42e113f9-9353-4e89-9f68-69b92f423b0c'}
    },
    priority: -10,
    customFields: {'order-id': '1234'},
    events: [],
    transactionID: '42e113f9-9353-4e89-9f68-69b92f423b0c'
  })
};

fetch('https://api.helpdesk.com/v1/importedTickets', 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.helpdesk.com/v1/importedTickets",
  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([
    'subject' => 'How to reset password',
    'teamIDs' => [
        '58ceb2d5-4bc9-483b-b2a9-456164431282',
        '58ceb2d5-4bc9-483b-b2a9-456164431283'
    ],
    'requester' => [
        'email' => 'requester@email.com',
        'name' => 'John Client'
    ],
    'tagIDs' => [
        '58ceb2d5-4bc9-483b-b2a9-456164431282',
        '58ceb2d5-4bc9-483b-b2a9-456164431283'
    ],
    'assignment' => [
        'team' => [
                'ID' => '42e113f9-9353-4e89-9f68-69b92f423b0c'
        ],
        'agent' => [
                'ID' => '42e113f9-9353-4e89-9f68-69b92f423b0c'
        ]
    ],
    'priority' => -10,
    'customFields' => [
        'order-id' => '1234'
    ],
    'events' => [
        
    ],
    'transactionID' => '42e113f9-9353-4e89-9f68-69b92f423b0c'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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.helpdesk.com/v1/importedTickets"

	payload := strings.NewReader("{\n  \"subject\": \"How to reset password\",\n  \"teamIDs\": [\n    \"58ceb2d5-4bc9-483b-b2a9-456164431282\",\n    \"58ceb2d5-4bc9-483b-b2a9-456164431283\"\n  ],\n  \"requester\": {\n    \"email\": \"requester@email.com\",\n    \"name\": \"John Client\"\n  },\n  \"tagIDs\": [\n    \"58ceb2d5-4bc9-483b-b2a9-456164431282\",\n    \"58ceb2d5-4bc9-483b-b2a9-456164431283\"\n  ],\n  \"assignment\": {\n    \"team\": {\n      \"ID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n    },\n    \"agent\": {\n      \"ID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n    }\n  },\n  \"priority\": -10,\n  \"customFields\": {\n    \"order-id\": \"1234\"\n  },\n  \"events\": [],\n  \"transactionID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.helpdesk.com/v1/importedTickets")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subject\": \"How to reset password\",\n  \"teamIDs\": [\n    \"58ceb2d5-4bc9-483b-b2a9-456164431282\",\n    \"58ceb2d5-4bc9-483b-b2a9-456164431283\"\n  ],\n  \"requester\": {\n    \"email\": \"requester@email.com\",\n    \"name\": \"John Client\"\n  },\n  \"tagIDs\": [\n    \"58ceb2d5-4bc9-483b-b2a9-456164431282\",\n    \"58ceb2d5-4bc9-483b-b2a9-456164431283\"\n  ],\n  \"assignment\": {\n    \"team\": {\n      \"ID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n    },\n    \"agent\": {\n      \"ID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n    }\n  },\n  \"priority\": -10,\n  \"customFields\": {\n    \"order-id\": \"1234\"\n  },\n  \"events\": [],\n  \"transactionID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.helpdesk.com/v1/importedTickets")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"subject\": \"How to reset password\",\n  \"teamIDs\": [\n    \"58ceb2d5-4bc9-483b-b2a9-456164431282\",\n    \"58ceb2d5-4bc9-483b-b2a9-456164431283\"\n  ],\n  \"requester\": {\n    \"email\": \"requester@email.com\",\n    \"name\": \"John Client\"\n  },\n  \"tagIDs\": [\n    \"58ceb2d5-4bc9-483b-b2a9-456164431282\",\n    \"58ceb2d5-4bc9-483b-b2a9-456164431283\"\n  ],\n  \"assignment\": {\n    \"team\": {\n      \"ID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n    },\n    \"agent\": {\n      \"ID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n    }\n  },\n  \"priority\": -10,\n  \"customFields\": {\n    \"order-id\": \"1234\"\n  },\n  \"events\": [],\n  \"transactionID\": \"42e113f9-9353-4e89-9f68-69b92f423b0c\"\n}"

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

{
  "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c",
  "licenseID": 13381337,
  "createdAt": "2026-06-30T22:02:08.901Z",
  "createdBy": "f56caf69-3f05-4386-9567-fdc909d7ad77",
  "createdByType": "agent",
  "updatedAt": "2026-06-30T22:02:08.901Z",
  "updatedBy": "f56caf69-3f05-4386-9567-fdc909d7ad77",
  "shortID": "IIPZGJ",
  "lastMessageAt": "2026-06-30T22:02:08.901Z",
  "parentTicket": {
    "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c",
    "shortID": "IIPZGJ",
    "subject": "Parent ticket subject"
  },
  "childTickets": [
    {
      "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c",
      "shortID": "IIPZGJ",
      "subject": "Child ticket subject"
    }
  ],
  "status": "open",
  "priority": -10,
  "subject": "Ticket subject",
  "teamIDs": [
    "42e113f9-9353-4e89-9f68-69b92f423b0c"
  ],
  "requester": {
    "email": "",
    "name": ""
  },
  "cc": [
    {
      "email": "cc@email.com",
      "name": "John Client"
    }
  ],
  "tagIDs": [
    "42e113f9-9353-4e89-9f68-69b92f423b0c"
  ],
  "followers": [
    "42e113f9-9353-4e89-9f68-69b92f423b0c"
  ],
  "assignment": {
    "team": {
      "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c",
      "name": ""
    },
    "agent": {
      "ID": "42e113f9-9353-4e89-9f68-69b92f423b0c",
      "name": ""
    }
  },
  "integration": {
    "type": "livechat",
    "referenceType": "",
    "referenceURL": "",
    "referenceID": ""
  },
  "customFields": {
    "order-id": "1234"
  },
  "ratingRequeestSent": true,
  "rating": {
    "rate": "good",
    "comment": "",
    "requestedAt": "2026-06-30T22:02:08.901Z"
  },
  "silo": "tickets",
  "spam": {
    "status": true,
    "reason": "licenseBlackList"
  },
  "source": {
    "type": "api"
  },
  "events": [
    {
      "type": "message"
    }
  ],
  "integrations": {
    "type": "livechat",
    "externalID": ""
  },
  "detectedLanguage": ""
}

Authorizations

Authorization

string

header

required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json

requester

object

required

The requester’s email and name.

Show child attributes

subject

string

The ticket subject.

teamIDs

string<uuid>[]

A list of teams that have access to the ticket.

tagIDs

string<uuid>[]

A list of tags.

assignment

object

The team or agent assignment.

Show child attributes

priority

enum<integer>

default:0

Value	Priority
-10	low
0	medium
10	high
20	urgent

Available options:

-10,

0,

10,

20

customFields

object

The object containing custom fields.

Example:

{ "order-id": "1234" }

events

object[]

A list of ticket events.

agentID, agentName and isPrivate are required for agent’s message. If these fields are not present, message is from requester.

Option 1
Option 2
Option 3
Option 4
Option 5

Show child attributes

transactionID

string<uuid>

Unique object identifier

Example:

"42e113f9-9353-4e89-9f68-69b92f423b0c"

Response

200 - application/json

Successful response.

string<uuid>

Unique object identifier.

licenseID

integer

Unique account identifier.

createdAt

string<date-time>

The time of creation.

createdBy

string<uuid>

The creator identifier.

createdByType

enum<string>

The creator type.

Available options:

agent,

client,

system

updatedAt

string<date-time>

The time of last modification.

updatedBy

string<uuid>

The modification author identifier.

shortID

string

The short ticket ID.

lastMessageAt

string<date-time>

The time of last public message.

parentTicket

object | null

The parent ticket reference.

Show child attributes

childTickets

object[]

The merged ticket reference.

Show child attributes

status

enum<string>

default:open

Ticket status

Available options:

open,

pending,

onhold,

solved,

closed

priority

enum<integer>

default:0

Value	Priority
-10	low
0	medium
10	high
20	urgent

Available options:

-10,

0,

10,

20

subject

string

teamIDs

string<uuid>[]

The teams that can access the ticket.

Unique object identifier

requester

object

Ticket requester

Show child attributes

object[]

A list of people in the loop.

Show child attributes

tagIDs

string<uuid>[]

A list of ticket tags.

Unique object identifier

followers

string<uuid>[]

A list of ticket followers (agents).

Unique object identifier

assignment

object

Team / agent assignment

Show child attributes

integration

object

Show child attributes

customFields

object

Object with custom fields values, where key is custom fields apiKey.

Example:

{ "order-id": "1234" }

ratingRequeestSent

boolean

default:false

Has rating request been sent.

rating

object | null

Ticket rating

Show child attributes

silo

enum<string>

default:tickets

Ticket silo (folder). Please check ticket silos section for more information

Available options:

tickets,

archive,

trash,

spam

spam

object

Show child attributes

source

object

Option 1
Option 2
Option 3
Option 4

Show child attributes

events

object[]

The ticket events.

Show child attributes

integrations

object

Option 1
Option 2

Show child attributes

detectedLanguage

string

The detected language code.

Update webhook

Create imported ticket transaction

Agents

Canned responses

Custom fields

Email domains

Mailboxes (inboxes)

Licenses

Reply addresses

Reports

Rules

Macros

Spam management

Tags

Teams

Templates

Audit log

Tickets

Transactions

Views

Webhooks

Imported tickets

Create imported ticket

Authorizations

Body

Response