Skip to content
/
Update a Custom Field

Business Management (1.0.0)

Full-featured B2B API for business operations.

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

⚠️ Version Status

V1 will be gradually deprecated. We recommend using V2 API for new integrations. V1 endpoints are maintained for backward compatibility, but new features will be released in V2 only.

Authentication

Requires both partner and user authorization:

Authorization: Bearer <partner_token>, User <user_token>
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-v1/openapi
Production
https://api.alteg.io/api/v1

Authentication B2B

User authentication and session management for B2B integrations

Operations

Locations

Manage business locations (salons, clinics, etc.)

Operations

Services

Service catalog management including categories and team member assignments

Operations

Team Members

Staff management including positions and scheduling

Operations

Clients

Client database management with comments, files, and visit history

Operations

Users & Permissions

User account management and role-based access control

Operations

Appointments

Booking records and visit management

Operations

Events

Group events and class management

Operations

Schedule & Resources

Timetables, schedules, and resource allocation

Operations

Products

Product catalog and categories

Operations

Inventory

Stock management, storage operations, and tech cards

Operations

Sales

Sales transactions and document management

Operations

Payments

Payment processing, accounts, and KKM transactions

Operations

Notifications

SMS and email notifications to clients

Operations

Online Booking Settings

Configure online booking behavior and forms

Operations

Analytics & Reports

Business analytics, charts, and Z-reports

Operations

Tags

Label management for categorizing entities (deprecated, use v2)

Operations

Deposits

Client deposit accounts and operations

Operations

Loyalty Cards

Loyalty card types, issuance, and manual transactions

Operations

Subscriptions & Certificates

Membership subscriptions and gift certificates

Operations

Loyalty Programs

Discount programs, referral programs, and loyalty transactions

Operations

Salary

Staff salary calculations, payroll, and schemes

Operations

Notification Settings

Configure notification types and user preferences

Custom Fields

Custom field definitions for various entities

Operations

Adding a Custom Field

Request

To add a field, the user must be part of the Chain associated with the location and have the appropriate access rights in the following section:
Settings → Access → Custom Fields → Create custom fields

Security
BearerPartnerUser
Path
field_categorystringrequired

Field category.

  • For appointments - appointment

  • For clients - client

Example: record
location_idintegerrequired

location ID

Headers
Acceptstringrequired

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

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

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Bodyapplication/jsonrequired
codestringrequired

Field ID

Example: "my_text_field"
show_in_uibooleanrequired

Whether to show the field in the interface

Example: true
titlestringrequired

Field name

Example: "test field"
typestringrequired

Field type

Example: "text"
user_can_editbooleanrequired

Can the user edit the field

Example: true
curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/custom_fields/record/{location_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "text",
    "code": "my_text_field",
    "title": "test field",
    "user_can_edit": true,
    "show_in_ui": true
  }'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataArray of objects

Array of objects with data

Example: [{"id":1,"salon_id":1,"custom_field":{"id":1,"code":"my_text_field","show_in_ui":true,"title":"test field","user_can_edit":true,"type":{"code":"text","title":"Text"}}}]
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{
  "success": true,
  "data": {
    "id": 1,
    "salon_id": 1,
    "custom_field": { … }
  },
  "meta": []
}

Update a Custom Field

Request

To update a field, the user must be part of the Chain associated with the location and have the appropriate access rights in the following section
Settings → Access → Custom Fields → Modify custom fields

Security
BearerPartnerUser
Path
field_categorystringrequired

Field category.

  • For appointments - appointment

  • For clients - client

Example: record
location_idintegerrequired

location ID

field_idintegerrequired

field ID

Headers
Acceptstringrequired

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

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

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Bodyapplication/jsonrequired
codestringrequired

Field ID

Example: "my_text_field"
show_in_uibooleanrequired

Whether to show the field in the interface

Example: true
titlestringrequired

Field name

Example: "test field"
typestringrequired

Field type

Example: "text"
user_can_editbooleanrequired

Can the user edit the field

Example: true
curl -i -X PUT \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/custom_fields/record/{location_id}/{field_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "text",
    "code": "my_text_field",
    "title": "test field",
    "user_can_edit": true,
    "show_in_ui": true
  }'

Responses

Accepted

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataArray of objects

Array of objects with data

Example: [{"id":1,"salon_id":1,"custom_field":{"id":1,"code":"my_text_field","show_in_ui":true,"title":"test field","user_can_edit":true,"type":{"code":"text","title":"Text"}}}]
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{
  "success": true,
  "data": null,
  "meta": {
    "message": "Saved"
  }
}

Remove a Custom Field from a Location

Request

To remove a field, the user must be part of the Chain associated with the location and have the appropriate access rights in the following section:
Settings → Access → Custom Fields → Remove custom fields

Security
BearerPartnerUser
Path
field_categorystringrequired

Field category.

  • For appointments - appointment

  • For clients - client

Example: record
location_idintegerrequired

location ID

field_idintegerrequired

field ID

Headers
Acceptstringrequired

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

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

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

curl -i -X DELETE \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/custom_fields/record/{location_id}/{field_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: string'

Responses

OK

Bodyapplication/json
successboolean

Execution success status (true)

Example: true
dataArray of objects

Array of objects with data

Example: [{"id":1,"salon_id":1,"custom_field":{"id":1,"code":"my_text_field","show_in_ui":true,"title":"test field","user_can_edit":true,"type":{"code":"text","title":"Text"}}}]
metaArray of objects

Metadata (empty array)

Example: []
Response
application/json
{
  "success": true,
  "data": null,
  "meta": {
    "message": "Deleted"
  }
}

Chain Management

Multi-location chain operations and clients

Operations

Chain Loyalty Programs

Chain-level loyalty programs and transactions

Operations

Fiscalization

Tax system integration and KKM callbacks

Operations

Utilities

License info, phone validation, images, and tips

Operations