Skip to main content
POST
/
tickets
Create a ticket
curl --request POST \
  --url https://api.qminder.com/tickets \
  --header 'Content-Type: application/json' \
  --header 'X-Qminder-API-Version: <x-qminder-api-version>' \
  --header 'X-Qminder-REST-API-Key: <api-key>' \
  --data '
{
  "lineId": "12345",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+12125551234",
  "email": "john@example.com",
  "languageCode": "en",
  "source": "MANUAL",
  "fields": [
    {
      "inputFieldId": "550e8400-e29b-41d4-a716-446655440000",
      "value": "Consultation"
    }
  ],
  "labels": [
    {
      "value": "VIP"
    }
  ]
}
'
{
  "id": "226859",
  "publicId": "A-42"
}

Authorizations

​
X-Qminder-REST-API-Key
string
header
default:yourbusinessapikey
required

Headers

​
X-Qminder-API-Version
enum<string>
default:2020-09-01
required

API version. Must be set to 2020-09-01.

Available options:
2020-09-01

Body

application/json
​
lineId
string
required

ID of the line to create the ticket in.

​
firstName
string
required

Visitor's first name (2-50 characters).

Required string length: 2 - 50
​
lastName
string

Visitor's last name (max 50 characters).

Maximum string length: 50
​
phoneNumber
string

Phone number with optional + prefix (5-20 digits). Example: +12125551234

Pattern: ^(\+)?([0-9]){5,20}$
​
email
string

Visitor's email address.

Maximum string length: 100
​
languageCode
string
default:en

Language code for the visitor (default: en).

Required string length: 2 - 5
​
source
enum<string>
default:MANUAL

Source of ticket creation. MANUAL = created by clerk, NAME = iPad Sign-in, MICROSITE = Visit Planner.

Available options:
MANUAL,
NAME,
MICROSITE
​
fields
object[]

Custom input fields for the ticket. See Input Fields query to discover available IDs.

​
labels
object[]

Labels to attach to the ticket.

Response

Ticket created successfully

​
id
string

Internal ticket ID.

Example:

"226859"

​
publicId
string

Public-facing ticket ID.

Example:

"A-42"