Skip to main content

User guide

Developer guide

Admin guide

English

Русский
English

User API documentation

API interaction

Matching

Profiles

Import profileUpdate profileImport multiple profilesUpdate multiple profilesAdd multiple profilesAdd profile to databaseImport profile to RabbitMQGet profile dataUploading profiles to a fileDelete profileSubscription fields functional updateDatabase fields functional updateMerging multiple profilesUnsubscribe profile from resourceProfile splitting
- Add or edit subscription Get all profile subscriptions Get all subscriptions from multiple profiles Get profile subscription Delete profile subscription Restore deleted subscription Suspend all subscriptions Unsuspend all suspended subscriptions
- Get profile action history Get multiple profiles action history
- Attach relation Detach relation Modify relation properties Overwrite relation properties Get profile relations info Get profile relations info
Get data for multiple profiles

Databases

Get database statistics Update statistics on database Get database list Get database information Get database fields Database wipe

Resources

Get resource statistics Update statistics on resource Get resources list Get resource information Get resource subscription fields

Segments

Create segment Get statistics on resource Update statistics on segment Add or remove profile Get profile data in a static segment Update segment Get segment information Get segments list Delete segment

Suppression lists

Create suppression listUpdate suppression listGet suppression list infoGet the list of suppression listsDelete suppression listUpload suppression list data to file
- Check if email is suppressed Add email to suppression list Add multiple emails to suppression list Remove email from suppression list Remove all emails from suppression list Check if domain is suppressed Add domain to suppression list Add multiple domains to suppression list Remove domain from suppression list Remove all domains from suppression list Check if phone number is suppressed Add phone number to suppression list Add multiple phones to suppression list Remove phone number from suppression list Remove all phone numbers from suppression list

Templates and fragments

Get templates list Get template info Delete template Add template Update template Channel object

Campaigns

Get campaign information Get campaign list Activate campaign Complete campaign Deactivate campaign Get campaign status

Mailings

Activate mailingDeactivate mailingGet mailing listGet mailing informationGet mailing logClone mailingDelete mailingGet mailing status
- Get broadcasts list Get broadcast information Create broadcast mailing Update broadcast mailing Launch a broadcast mailing
- Get regular mailings list Get regular mailing information Create regular mailing Update regular mailing Launch a regular mailing
- Get trigger mailings list Get trigger mailing information Create trigger mailing Update trigger mailing Trigger launch (API call)Profile import + trigger mailing launch Task for bulk trigger launch Task for bulk profiles import + trigger launch Bulk trigger launch Bulk profiles import + trigger mailing launch Clone a trigger mailing Data array

Automation scenarios

Engage profile in scenario Import and engage profile in scenario Batch import and engage profiles in a scenario Task for batch import and engaging profiles in the scenario Get scenarios list Activate scenario Deactivate scenario Get scenario information Change scenario priority

Loyalty Programs

Get profile tier in a loyalty program Export points transactions Expiring points for a period Get profile account transactions Get trigger promotions list Accrue points to a member Redeem member points Commit temporary transaction Preliminary Order Calculation Order Confirmation Roll back temporary transaction Cancel points transaction Get points account balance Register member in a loyalty program Batch adding participants to loyalty program Task for batch add participants to loyalty program Remove member from loyalty program

Forms

Get form information Get form list Export form fill data by user Export form fill data Publish form Unpublish form Delete form

Promo codes

Import promo codes Get promo code information Activate promo code Update promo code Attach promo code Detach promo code Get all promo codes

Goals

Goals and goal values registration

Application push notifications

Processing and adding a subscription Add app push events

Market

- Order data object Product data object SKU data object Categories array Custom fields array
- Import order and item statuses Get orders list Delete order Get order status Update order line status
- Import products, SKUs and categories Import SKUs and categories Get products list Get SKUs list Delete products Delete SKU

Analytic reports

Get summary report Get soft bounces report Get undeliveries report

Senders

Get senders list
- Get virtual senders list Get virtual sender information Clone virtual sender Create virtual sender Update virtual sender Delete virtual sender

External datatables queries

- Add segmentation query Update segmentation query Get segmentation query information Get segmentation queries list Delete segmentation query
- Add template query Update template query Get template query information Get template queries list Delete template query

Objects

AKMTA object Content object Custom channels rules Email rule object File object Profile data object SMS rule object Sender object Sender types Start schedule object Subscription object Trigger types

Miscellaneous

Upload file Get message web version Push providers Deduplication of requests How to send API request with RabbitMQ List of gender identifications Obtain valid values for fields: browsers, devices, tz, oses, languages

Importing the API collection in Postman

List of API endpoints

SDK

- - Quick start SDK functionality SDK Configuration Public SDK API
    Provider setup
    Firebase Cloud Messaging Huawei Mobile Services RuStore
  - Quick start SDK configuration SDK functionality Public SDK API
    Provider configuration
    Apple Push Notification Service Firebase Cloud Messaging Huawei Mobile Services
  - Quick Start SDK Configuration SDK Functionality Public SDK API Provider setup
  - Quick Start SDK Configuration SDK Functionality SDK Public API Provider Setup
  Working with role and JWT tokens
Web Push SDK

SDK
mSDK
Android
Provider setup

Provider setup

Firebase Cloud Messaging

Huawei Mobile Services

RuStore

Last updated on Sep 24, 2025