Skip to content
/
Create Event Appointment...

Business Management (2.0.0)

Next-generation B2B API with improved design and consistency.

Base URL: https://api.alteg.io/api

🚀 Version Status

V2 is in active development. This API version is being actively developed and expanded. New features and improvements are released here first. We recommend using V2 for all new integrations.

Authentication

Requires both partner and user authorization:

Authorization: Bearer <partner_token>, User <user_token>

About v2

V2 endpoints offer improved request/response structures and consistent naming. This collection is actively growing as we modernize the API.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Altegio API Agreement
Terms of Service
Languages
Servers
Mock server
https://developer.alteg.io/_mock/en/b2b-v2/openapi/
Production
https://api.alteg.io/api/v2/

Team Members

Team member and position management.

Operations

Events

Group events (activities) management.

Operations

Delete Event (v2)

Request

Deletes an Event using v2 API.

Security
BearerPartnerUser
Path
location_idintegerrequired

Location (business) ID

event_idintegerrequired

Event ID

Headers
Acceptstringrequired
Default application/vnd.api.v2+json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X DELETE \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/companies/{location_id}/activities/{event_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>'

Responses

Event deleted successfully

Bodyapplication/json
Response
application/json
null

Create Event Appointment (v2)

Request

Creates an Appointment for a Client in an Event using v2 API.

Note: All client fields are required even when using existing client ID.

Security
BearerPartnerUser
Path
location_idintegerrequired

Location (business) ID

event_idintegerrequired

Event ID

Headers
Acceptstringrequired
Default application/vnd.api.v2+json
Content-Typestringrequired
Default application/json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

Bodyapplication/jsonrequired
clientobjectrequired

Client information

client.​namestringrequired

First name

Example: "John"
client.​phonestringrequired

Phone number

Example: "+13155550175"
client.​emailstringrequired

Email address

Example: "john@example.com"
client.​surnamestringrequired

Last name

Example: "Smith"
client.​genderintegerrequired

Gender: 0 - unknown, 1 - male, 2 - female

Enum012
Example: 0
client.​idinteger

Client ID for existing client

Example: 123456
client.​patronymicstring or null

Middle name (legacy field name)

Example: null
One of:

Middle name (legacy field name)

string
client.​birthdaystring or null

Birth date

Example: "1990-01-01"
One of:

Birth date

string(date)
client.​custom_field_valuesArray of objects or null

Custom field values

One of:

Custom field values

client.​agreementsArray of objects or null

User agreements/consents

One of:

User agreements/consents

clients_countintegerrequired

Number of participants/slots to reserve

Example: 1
client_idinteger

Existing client ID (deprecated, use client.id instead)

Example: 123456
comer_idinteger

Visitor ID (alternative to client)

Example: 500
comerobject

Visitor information (alternative to client)

labelsArray of integers

Tag IDs for this appointment

Example: [1,2]
curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/companies/{location_id}/activities/{event_id}/records' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "client_id": 123456,
    "client": {
      "id": 123456,
      "name": "John",
      "phone": "+13155550175",
      "email": "john@example.com",
      "surname": "Smith",
      "patronymic": null,
      "gender": 0,
      "birthday": "1990-01-01",
      "custom_field_values": [
        {
          "code": "string",
          "value": "string"
        }
      ],
      "agreements": [
        {
          "is_newsletter_allowed": true,
          "is_personal_data_processing_allowed": true
        }
      ]
    },
    "comer_id": 500,
    "comer": {
      "name": "Guest User"
    },
    "labels": [
      1,
      2
    ],
    "clients_count": 1
  }'

Responses

Appointment created successfully

Bodyapplication/json
dataobject

Created appointment details (JSON:API format)

metaArray of objects
Response
application/json
{
  "data": {
    "type": "record",
    "id": "624798251",
    "attributes": { … }
  },
  "meta": [
    {}
  ]
}

Update Event Appointment (v2)

Request

Updates an existing Appointment in an Event using v2 API.

Note: This endpoint uses PATCH (not POST as in some documentation).

Security
BearerPartnerUser
Path
location_idintegerrequired

Location (business) ID

event_idintegerrequired

Event ID

record_idintegerrequired

Appointment ID

Headers
Acceptstringrequired
Default application/vnd.api.v2+json
Content-Typestringrequired
Default application/json
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

Bodyapplication/jsonrequired
reschedule_activity_idintegerrequired

Event ID to reschedule this Appointment to (required field)

Example: 12345
attendance_service_itemobject

Service pricing information

attendance_good_itemsArray of objects

Products associated with this appointment

commentstring

Appointment comment

Example: "Updated appointment comment"
label_idsArray of integers

Tag IDs

Example: [123,456]
colorstring

Appointment color (hex without

Example: "f44336"
clients_countinteger

Number of participants

Example: 2
curl -i -X PATCH \
  'https://developer.alteg.io/_mock/en/b2b-v2/openapi/companies/{location_id}/activities/{event_id}/records/{record_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "reschedule_activity_id": 12345,
    "attendance_service_item": {
      "cost_per_unit": 100,
      "discount_percent": 10,
      "manual_cost": 90
    },
    "attendance_good_items": [
      {
        "id": 0,
        "good_id": 0,
        "unit_id": 0,
        "storage_id": 0,
        "staff_id": 0,
        "operation_unit_type": "sale",
        "number": 0,
        "planned_activation_date": "2019-08-24T14:15:22Z",
        "marks": [
          "string"
        ],
        "quantity": 0,
        "cost_per_unit": 0,
        "manual_cost": 0,
        "discount_percent": 0
      }
    ],
    "comment": "Updated appointment comment",
    "label_ids": [
      123,
      456
    ],
    "color": "f44336",
    "clients_count": 2
  }'

Responses

Appointment updated successfully

Bodyapplication/json
successboolean
Example: true
dataobject
metaobject
Response
application/json
{
  "success": true,
  "data": {},
  "meta": {}
}

Tags

Client tagging system.

Operations