Skip to main content
POST
Create a ticket

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"