ALalteg
Online Booking

Book Event

Changed on
post/activity/{location_id}/{event_id}/book

Request

  • Base URL
    https://api.alteg.io/api/v1
  • URL
    https://api.alteg.io/api/v1/activity/{location_id}/{event_id}/book
  • Auth
    HTTP bearer

Path parameters

location_idnumber required

location ID

event_idinteger required

Event ID

Headers

Acceptstring required

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

Content-Typestring required

application/json

Request body */*

fullnamestring required

Client name

phonestring required

Customer phone (for example +13155550175)

emailstring required

Postal address of the client

national_idstring

Client IIN — 12 digits with a valid check digit. Accepted only for locations in Kazakhstan and ignored for other countries. Optional: when omitted or empty, the IIN already saved for the client is left unchanged.

codenumber

SMS confirmation code for verifying the phone number. This field is required if the location has phone_confirmation = true

commentstring

Appointment Comment

notify_by_smsinteger

Specifies how many hours in advance an SMS reminder should be sent before the appointment. Set to 0 to disable SMS reminders.

notify_by_emailinteger

Specifies how many hours in advance an email reminder should be sent before the appointment. Set to 0 to disable email reminders

typestring

Appointment source

api_idnumber

Appointment ID from external system

clients_countnumber

number of seats

Example request

{
  "fullname": "James Smith",
  "phone": "+13155550175",
  "email": "j.smith@example.com",
  "national_id": "950315300129",
  "code": 0,
  "comment": "",
  "notify_by_sms": 0,
  "notify_by_email": 0,
  "type": "mobile"
}

Response

OK

successboolean

Execution success status (true)

metaobject[]

Metadata (empty array)

Example response

{
  "success": true,
  "data": {
    "id": 28417878,
    "hash": "9e6a54a1a9b118b65cc39ab6f3c3b5b4"
  },
  "meta": []
}

Changes