Skip to main content
POST
/
v1
/
appointments
Create an appointment
curl --request POST \
  --url https://api.qminder.com/v1/appointments \
  --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",
  "startTime": "2024-12-15T10:00:00Z",
  "endTime": "2024-12-15T10:30:00Z",
  "assigneeId": 789
}
'
{
  "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
integer
required

ID of the line to create the appointment in.

​
firstName
string
required

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

Required string length: 2 - 50
​
startTime
string<date-time>
required

Appointment start time in ISO 8601 format.

​
endTime
string<date-time>
required

Appointment end time in ISO 8601 format.

​
assigneeId
integer
required

ID of the user to assign the appointment to.

​
lastName
string

Visitor's last name (max 50 characters).

Maximum string length: 50
​
phoneNumber
string

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

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

Visitor's email address.

Maximum string length: 100
​
languageCode
string
default:en

Language code for the visitor (default: en).

Required string length: 2 - 5
​
fields
object[]

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

​
labels
object[]

Labels to attach to the appointment.

Response

Appointment created successfully

​
id
string

Internal appointment ticket ID.

​
publicId
string

Public-facing ticket ID.