v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Tickets

Add a new ticket

Required scopes: flex.collaboration.tickets.create

post/api/v2/organizations/{orgSlug}/tickets

Path parameters

orgSlugstring required

organization slug

Request body

typestring required

The _id of the ticket options.

severitystring required

The _id of the ticket severity.

prioritystring required

The _id of the ticket priority

memberstring required

The _id of the member who has created the ticket.

subjectstring required

The ticket description.

attachmentsstring[]

An array of strings containing the URLs of all images attachments

messagestring

The ticket message.

Example request

{
  "type": "6a4e2038aedbb38ad5b3f70a",
  "severity": "6a4e2038aedbb38ad5b3f70b",
  "priority": "6a4e2038aedbb38ad5b3f70c",
  "member": "6a4e2038aedbb38ad5b3f70d",
  "subject": "Support query",
  "attachments": [
    "https://example.com/image.jpg",
    "https://example.com/image2.jpg"
  ],
  "message": "This is the message of the ticket"
}

Response

_idstring

The _id of the item.

typestring

The _id of the ticket options.

severitystring

The _id of the ticket severity.

prioritystring

The _id of the ticket priority

companystring

The _id of the company with which the ticket will be associated.

memberstring

The _id of the member who has created the ticket.

locationstring

The _id of the location with which the ticket is associated.

status'open' | 'new' | 'pending' | 'resolved'

The status of the ticket.

assignedTostring

The _id of the location to whom the ticket is assigned.

resolvedDatestring

The date of the resolution date of the ticket.

attachmentsstring[]

An array of strings containing the URLs of all images attachments

subjectstring

The ticket description.

messagestring

The ticket message.

createdAtstring date-time

The date when the ticket has been created at.

modifiedAtstring date-time

The date when the ticket has been modified for the last time.

Example response

{
  "_id": "6a4e2038aedbb38ad5b3f710",
  "type": "6a4e2038aedbb38ad5b3f711",
  "severity": "6a4e2038aedbb38ad5b3f712",
  "priority": "6a4e2038aedbb38ad5b3f713",
  "company": "6a4e2038aedbb38ad5b3f714",
  "member": "6a4e2038aedbb38ad5b3f715",
  "location": "6a4e2038aedbb38ad5b3f716",
  "assignedTo": "6a4e2038aedbb38ad5b3f717",
  "resolvedDate": "2025-03-01T00:00:00.000Z",
  "attachments": [
    "https://example.com/image.jpg",
    "https://example.com/image2.jpg"
  ],
  "subject": "Support query",
  "message": "This is the message of the ticket",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "modifiedAt": "2025-01-01T00:00:00.000Z"
}