Skip to main content
POST
/
tickets
Create a ticket
curl --request POST \
  --url https://{your-workspace}.neetodesk.com/api/v1/public/tickets \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '{
  "email": "john@example.com",
  "subject": "How to resolve the pending payments",
  "description": "I need your help in resolving the pending payments.",
  "ticket_fields": {
    "Country": "USA"
  },
  "name": "John Luther",
  "channel": "email",
  "to": "[\"eve@example.com\",\"kevin@example.com\"\"]",
  "cc": "[\"eve@example.com\",\"kevin@example.com\"\"]",
  "group": "sales",
  "assignee_email": "oliver@example.com"
}'
{
  "notice_code": "<string>",
  "ticket": {
    "id": "<string>",
    "number": 123,
    "url": "<string>"
  }
}
Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

​
X-Api-Key
string
default:your-api-key
required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Body

application/json
​
email
string
required

Email address of the customer.

Example:

"john@example.com"

​
subject
string
required

Subject for the ticket.

Example:

"How to resolve the pending payments"

​
description
string
required

Description for the ticket.

Example:

"I need your help in resolving the pending payments."

​
ticket_fields
object

Custom ticket fields. Refer to the ticket fields article for more details.

Example:
{ "Country": "USA" }
​
name
string

Name of the customer.

Example:

"John Luther"

​
channel
enum<string>

Source of the ticket. Defaults to api if not specified or if an invalid channel is provided.

Available options:
email,
ui,
twitter,
chat,
form,
api,
whatsapp,
telephony
Example:

"email"

​
to
string

Array of additional emails to be added to the to field of any responses from the ticket.

Example:

"[\"eve@example.com\",\"kevin@example.com\"\"]"

​
cc
string

Array of emails to be added to the cc field of any responses from the ticket.

Example:

"[\"eve@example.com\",\"kevin@example.com\"\"]"

​
group
string

Name of an existing group.

Example:

"sales"

​
assignee_email
string<email>

Email address belonging to a team member.

Example:

"oliver@example.com"

Response

200 - application/json

OK - Request succeeded

​
notice_code
string
​
ticket
object
⌘I