Tickets

/tickets

Create a new ticket

post/tickets

Request

  • Base URL
    <<api-url>> (relative, and the document’s source URL is not known)
  • Auth
    API key in header X-API-KEY

Headers

octa-agent-emailstring

Request body

summarystring required

Ticket summary

descriptionstring required

Ticket description

ccstring[]
ccostring[]
tagsstring[]

Example request

{
  "attachments": [
    {
      "name": "image.png",
      "base64": "iVBORw0KGgoAAAANSUhEUgAA...",
      "mimeType": "image/png",
      "url": "https://storage.googleapis.com/octadesk-bucket/files/document.pdf"
    }
  ]
}

Response

idstring

Ticket ID

numbernumber

Ticket number

summarystring required

Ticket summary

descriptionstring required

Ticket description

ccstring[]
ccostring[]
tagsstring[]
createdAtstring date-time

Ticket opening date

resolutionDatestring date-time

Ticket resolution/closed date

interactionsCountnumber

Interaction quantities on the ticket

totalEmployeeInteractionsnumber required

Total employee interactions on the ticket

timePerAssignedstring

Time per assigned (from SLA)

timePerGroupAssignedstring

Time per group assigned (from SLA)

updatedAtstring date-time

Ticket last updated date

Changes

No recorded changes to this operation across all 2 revisions of this API.