Create Ticket

All API requests should contain authorization headers.

Request

POST /tickets

Query Parameters.

This endpoint doesn't require query parameters.

Request Body

{
    "assigneeId": "43b8adc7-755d-2be3-afb1-b6a462631977",
    "attachments": [
        {
            "url": "https://your.attachment.url/filename.png",
            "name": "filename.png"
        }
    ],
    "categoryId": 15597,
    "cc": [
        "ann_smith@gmail.com"
    ],
    "creator": {
        "name": "Bill Smith",
        "email": "bill_smith@gmail.com",
        "image": null,
        "phoneNumber": null
    },
    "customFields": [
        {
            "id": 42623,
            "value": "Oslo"
        }
    ],
    "message": "Hello I want to buy a new car, how can I get a price list?",
    "sentiment": "question",
    "tags": [],
    "title": "New car price list."
}

Body of request should contain the following model serialized to JSON.

Field
Type
Comments

attachments

array of Base Attachment models

Ticket Attachments

assigneeId

string

Unique teammate ticket assignee Id. Set to null if the ticket does not have any assignee. You can obtain a list of teammates through the Teammates route

categoryId

nullabe integer

Unique Id of category ticket should belong to. If value is null ticket will be created uncategorized

cc

array of strings

CC emails of ticket. Team member replies will be sent not only to ticket author but also to these emails

creator

Model contains ticket creator data.

customFields

List of models containing custom field ids and values

isHtml

boolean

If true indicates that message content should be processed as HTML with tags, classes and attributes.

By default is true

message

string

Ticket message

sentiment[^1]

string

Sentiment of ticket. Can be question, praise, suggestion, complaint

sourceName

string

Name of ticket source. Can have any string as value (for example page or channel name)

tags

array of string

Ticket tags' names

title

string

Title of the ticket

Response

{
  "data": 4484636,
  "errorCode": -1,
  "errorText": null
}

Data field will contain ticket Id (type integer).

Last updated