Mark the status of an appointment as checked-in
This API helps you to mark the status of an appointment as checked-in. By doing so, you can provide your guests the option to self check-in for their scheduled appointments from your CMA and custom Webstore.
You must specify appropriate data for the appointment_group_id parameter.
Before you begin
- You need a valid API key or access token. See Set up API authentication.
Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.
Endpoint
PUT /v1/appointments/{appointment_group_id}/check_in
Base URL: https://api.zenoti.com
Request
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | bearer {{access_token}} |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| appointment_group_id | string | Yes | Mandatory Unique 32-character identifier of the required appointment group. |
Response
Success (200 OK)
{
"success": true,
"ërror": {}
}
Response fields
| Field | Type | Description |
|---|---|---|
| success | boolean | |
| ërror | object |
Example
curl --request PUT \
--url 'https://api.zenoti.com/v1/appointments/{appointment_group_id}/check_in' \
--header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/appointments/{appointment_group_id}/check_in', {
method: 'PUT',
headers: {
'Authorization': 'bearer {{access_token}}'
},
});
const data = await response.json();
import requests
response = requests.put(
'https://api.zenoti.com/v1/appointments/{appointment_group_id}/check_in',
headers={
'Authorization': 'bearer {{access_token}}',
},
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.PutAsync(
"https://api.zenoti.com/v1/appointments/{appointment_group_id}/check_in");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'
uri = URI('https://api.zenoti.com/v1/appointments/{appointment_group_id}/check_in')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Put.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
response = http.request(request)
data = JSON.parse(response.body)
Error codes
| Status | Description |
|---|---|
| 400 | 400 |
| 401 | Unauthorized -- invalid or expired access token |
| 429 | Too many requests -- rate limit exceeded |