User authentication and session management for B2B integrations
- Get User Notification Settings
Send SMS to the list of clients
Send SMS campaigns to customers matching the filters
Send Email newsletter according to the list of clients
Send email campaigns for clients matching the filters
Getting Message Statuses
Get notification settings in a location
Change User Push Notification Settings
Get User Notification Set...
Business Management (1.0.0)
Full-featured B2B API for business operations.
Base URL: https://api.alteg.io/api
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.
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://developer.alteg.io/_mock/en/b2b-v1/openapi/
Production
https://api.alteg.io/api/v1/
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/notification_settings/{location_id}/notification_types
- Productionhttps://api.alteg.io/api/v1/notification_settings/{location_id}/notification_types
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.alteg.io/_mock/en/b2b-v1/openapi/notification_settings/{location_id}/notification_types' \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: string'OK
Array of objects
Example: [{"type":"record_create_online_staff","channels":{"push":1,"sms":0,"email":1}},{"type":"record_move_admin","channels":{"push":1,"sms":0,"email":0}},{"type":"license_expire","channels":{"push":1,"sms":1,"email":1}},{"type":"record_create_offline_admin","channels":{"push":1,"sms":0,"email":1}},{"type":"record_create_offline_staff","channels":{"push":1,"sms":0,"email":0}},{"type":"record_create_online_admin","channels":{"push":1,"sms":0,"email":1}},{"type":"record_delete_admin","channels":{"push":0,"sms":0,"email":1}},{"type":"record_delete_staff","channels":{"push":1,"sms":0,"email":0}},{"type":"record_move_staff","channels":{"push":0,"sms":0,"email":0}}]
Response
application/json
{ "success": true, "data": [ { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … }, { … } ], "meta": { "count": 9 } }
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/notification_settings/{location_id}/users/{user_id}
- Productionhttps://api.alteg.io/api/v1/notification_settings/{location_id}/users/{user_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.alteg.io/_mock/en/b2b-v1/openapi/notification_settings/{location_id}/users/{user_id}' \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: string'OK
Object with data
Example: {"mode":"staff","notification_types":[{"type":"record_create_online_staff","channels":{"push":1,"sms":0,"email":1}},{"type":"record_create_offline_staff","channels":{"push":1,"sms":0,"email":0}},{"type":"record_delete_staff","channels":{"push":0,"sms":0,"email":0}},{"type":"record_move_staff","channels":{"push":0,"sms":0,"email":0}},{"type":"license_expire","channels":{"push":0,"sms":0,"email":0}}]}
Response
application/json
{ "success": true, "data": { "mode": "staff", "notification_types": [ … ] }, "meta": [] }
Request
The method allows you to change the user's PUSH notification settings. The type of notification to be changed (record_create_online_staff or record_create_online_admin, etc.) should be selected based on the type of notification specified by the user (mode: admin or mode: team_member). Note: 'staff' in notification type names is a legacy term for team member.
Security
BearerPartnerUser
Array of objects
Example: [{"type":"record_create_online_admin","channels":{"push":1}},{"type":"record_create_offline_admin","channels":{"push":1}},{"type":"record_delete_admin","channels":{"push":1}},{"type":"record_move_admin","channels":{"push":1}},{"type":"license_expire","channels":{"push":1}}]
- Mock serverhttps://developer.alteg.io/_mock/en/b2b-v1/openapi/notification_settings/{location_id}/users/{user_id}
- Productionhttps://api.alteg.io/api/v1/notification_settings/{location_id}/users/{user_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://developer.alteg.io/_mock/en/b2b-v1/openapi/notification_settings/{location_id}/users/{user_id}' \
-H 'Accept: string' \
-H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"notification_types": [
{
"type": "record_create_online_admin",
"channels": {
"push": 1
}
},
{
"type": "record_create_offline_admin",
"channels": {
"push": 1
}
},
{
"type": "record_delete_admin",
"channels": {
"push": 1
}
},
{
"type": "record_move_admin",
"channels": {
"push": 1
}
},
{
"type": "license_expire",
"channels": {
"push": 1
}
}
]
}'OK
Object with data
Example: {"mode":"staff","notification_types":[{"type":"record_create_online_staff","channels":{"push":1,"sms":0,"email":1}},{"type":"record_create_offline_staff","channels":{"push":1,"sms":0,"email":0}},{"type":"record_delete_staff","channels":{"push":0,"sms":0,"email":0}},{"type":"record_move_staff","channels":{"push":0,"sms":0,"email":0}},{"type":"license_expire","channels":{"push":0,"sms":0,"email":0}}]}
Response
application/json
{ "success": true, "data": { "mode": "staff", "notification_types": [ … ] }, "meta": [] }