v1

latestOpenAPI 3.1.1Altegio API Agreement2026-08-062438211.0 KB

Online Booking

Validate Booking Parameters

After generating the appointment parameters, you can validate them to ensure the appointment can be successfully created.

The JSON object containing the Online Booking parameters includes the following fields:

Field	Type	Mandatory	Description
appointments	Array of objects	YES	Booking options (services, team members...)

The appointments array consists of objects that have the following fields:

Field	Type	Mandatory	Description
id	number	Yes	Appointment ID for post-save feedback (see response to request).
services	array of numbers	NO	Array of IDs of the services the client wants to sign up for
staff_id	number	YES	ID of the team member the client wants to book with (0 if any team member is selected)
datetime	datetime	YES	Session date and time in ISO8601 format (passed for each session in the book_times resource)

In response to the parameter check request, an empty response with the code 201 will be returned if the booking parameters are in order and bookings can be created:

If the response is JSON with an HTTP code other than 201, then the booking parameters are out of order, and bookings cannot be created.

The server may return the following errors during appointment creation:

Selected time slot is already taken. Returned with HTTP status code 422 and error code 433.
No team members available for booking. Occurs if a default team member was selected but none are available. Returned with HTTP status code 422 and error code 436.
Booking time conflict within the same request. One of the selected booking times overlaps with another booking created in the same request. Returned with HTTP status code 422 and error code 437, including the conflicting booking’s id in the appointments array.
Service not available for booking The selected service is no longer available (e.g. removed by the location). Returned with HTTP status code 422 and error code 438.

post/book_check/{location_id}

Path parameters

location_idnumber required

location ID

Headers

Acceptstring required

e.g. application/vnd.api.v2+json

Content-Typestring required

application/json

Authorizationstring required

Bearer partner_token

Request body

appointmentsobject[] required

appointment options (services, team members...)

Example request

{
  "appointments": [
    {
      "id": 1,
      "services": [
        331
      ],
      "staff_id": 6544,
      "datetime": "2026-09-21T23:00:00.000-05:00"
    },
    {
      "id": 2,
      "services": [
        99055
      ],
      "staff_id": 6544,
      "datetime": "2026-09-21T23:00:00.000-05:00"
    }
  ]
}

Response

Created

successboolean

Execution success status (true)

{"stackTrail":"components:schemas:book_check_companyid_response201_data_types:properties:data","oasType":"schema","type":"unknown","description":"Always null for this response"}

Example response

{
  "success": true,
  "data": null,
  "meta": {
    "message": "Created"
  }
}