Skip to content
/
Book Event

Book Event

Request

Security
BearerPartner
Path
location_idnumberrequired

location ID

event_idintegerrequired

Event ID

Headers
Acceptstringrequired

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

Example:application/vnd.api.v2+json
Content-Typestringrequired

application/json

Body*/*required
fullnamestringrequired

Client name

Example:"James Smith"
phonestringrequired

Customer phone (for example +13155550175)

Example:"+13155550175"
emailstringrequired

Postal address of the client

Example:"j.smith@example.com"
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.

Example:"950315300129"
codenumber

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

Example:0
commentstring

Appointment Comment

Example:""
notify_by_smsinteger, (int32)

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

Example:0
notify_by_emailinteger, (int32)

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

Example:0
typestring

Appointment source

Example:"mobile"
api_idnumber

Appointment ID from external system

clients_countnumber

number of seats

curl -i -X POST \
  'https://developer.alteg.io/_mock/en/public/openapi/activity/{location_id}/{event_id}/book' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}_HERE>' \
  -H 'Content-Type: */*' \
  -d '{
    "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"
  }'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example:true
dataobject

Object with data

Example:
{
  "id": 28417878,
  "hash": "9e6a54a1a9b118b65cc39ab6f3c3b5b4"
}
metaArray of objects

Metadata (empty array)

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