v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
tickets

Create Ticket

This endpoint creates a new Ticket.

post/tickets/create

Headers

x-phonestring
Example:{{orgPhone}}

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Request body

chat_idstring required
  • The unique id of the chat
  • For individual chats, this would be the country_code + number (e.g., 918527184400), followed by @c.us
  • For groups, this would end with @g.us
subjectstring required
  • Updates the subject of the ticket
labelsstring
  • A comma-separated list of labels to be assigned to the contacts. All labels are case-insensitive.
  • If any label currently does not exist, it will be created
  • Note: This replaces all the current labels of the contact
assigneestring
  • Update the assignee of the ticket. Must be an email of a user in the organization
quoted_message_idstring
  • The quoted message id for the ticket
due_datestring
  • Updates the due date of the ticket.
  • Must be a string that can be parsed to a date
prioritystring
  • Updates the priority of the ticket.
  • Only accepts the following values - 1,2,3,4
    • 1 = Low
    • 2 = Medium
    • 3 = High
    • 4 = Urgent
statusstring
  • Updates the status of the ticket.
  • Only accepts the following values - open, inprogress, closed, archived

Example request

{
  "chat_id": "919537851844@c.us",
  "subject": "New subject 1",
  "labels": "Test, Demo",
  "assignee": "bharat@periskope.app",
  "quoted_message_id": "3EB0ABB7C973860FC19EBE05FD934141CCEC2D8B",
  "due_date": "2025-04-20",
  "priority": "2",
  "status": "closed"
}

Response

200 OK

object required

The response is a ticket object. Refer to the ticket object here