Skip to main content
Altcraft Docs LogoAltcraft Docs Logo
User guide iconUser guide
Developer guide iconDeveloper guide
Admin guide iconAdmin guide
English
  • Русский
  • English
Login
    User API documentationAPI interactionMatching
      Profilesarrow
    • Import profileUpdate profileImport multiple profilesUpdate multiple profilesAdd multiple profilesAdd profile to databaseQuick profile importImport profile to RabbitMQGet profile dataUploading profiles to a fileSuspend all database profilesUnsuspend all profiles in a databaseDelete profileSubscription fields functional updateDatabase fields functional updateMerging multiple profilesUnsubscribe profile from resourceProfile splitting
        Subscriptionsarrow
      • Add or edit subscriptionGet all profile subscriptionsGet all subscriptions from multiple profilesGet profile subscriptionDelete profile subscriptionRestore deleted subscriptionSuspend all subscriptionsUnsuspend all suspended subscriptions
        Action historyarrow
      • Get profile action historyGet multiple profiles action history
        Profile relationsarrow
      • Attach relationDetach relationModify relation propertiesOverwrite relation propertiesGet profile relations infoGet profile relations info
      Get data for multiple profiles
      Databasesarrow
    • Get database statisticsUpdate statistics on databaseGet database listGet database informationGet database fieldsDatabase wipe
      Resourcesarrow
    • Get resource statisticsUpdate statistics on resourceGet resources listGet resource informationGet resource subscription fields
      Segmentsarrow
    • Get statistics on resourceUpdate statistics on segmentAdd or remove profileGet profile data in a static segmentCreate segmentUpdate segmentGet segment informationGet segments listDelete segment
      Suppression listsarrow
    • Create suppression listUpdate suppression listGet suppression list infoGet the list of suppression listsDelete suppression listUpload suppression list data to file
        Suppression list actionsarrow
      • Check if email is suppressedAdd email to suppression listAdd multiple emails to suppression listRemove email from suppression listRemove all emails from suppression listCheck if domain is suppressedAdd domain to suppression listAdd multiple domains to suppression listRemove domain from suppression listRemove all domains from suppression listCheck if phone number is suppressedAdd phone number to suppression listAdd multiple phones to suppression listRemove phone number from suppression listRemove all phone numbers from suppression list
      Templates and fragmentsarrow
    • Get templates listGet template infoDelete templateAdd templateUpdate templateChannel object
      Campaignsarrow
    • Get campaign informationGet campaign listActivate campaignComplete campaignDeactivate campaignGet campaign status
      Mailingsarrow
    • Activate mailingDeactivate mailingGet mailing listGet mailing informationGet mailing logClone mailingDelete mailingGet mailing status
        Broadcast mailingsarrow
      • Get broadcasts listGet broadcast informationCreate broadcast mailingUpdate broadcast mailingLaunch a broadcast mailing
        Regular mailingsarrow
      • Get regular mailings listGet regular mailing informationCreate regular mailingUpdate regular mailingLaunch a regular mailing
        Trigger mailingsarrow
      • Get trigger mailings listGet trigger mailing informationCreate trigger mailingUpdate trigger mailingTrigger launch (API call)Profile import + trigger mailing launchTask for bulk trigger launchTask for bulk profiles import + trigger launchBulk trigger launchBulk profiles import + trigger mailing launchClone a trigger mailingData array
      Automation scenariosarrow
    • Engage profile in scenarioImport and engage profile in scenarioBatch import and engage profiles in a scenarioTask for batch import and engaging profiles in the scenarioGet scenarios listActivate scenarioDeactivate scenario
      Loyalty Programsarrow
    • Get profile tier in a loyalty programExport points transactionsExpiring points for a periodGet profile account transactionsGet trigger promotions listAccrue points to a memberRedeem member pointsCommit temporary transactionPreliminary Order CalculationOrder ConfirmationRoll back temporary transactionCancel points transactionGet points account balanceRegister member in a loyalty programRemove member from loyalty program
      Promo codesarrow
    • Import promo codesGet promo code informationActivate promo codeUpdate promo codeAttach promo codeDetach promo codeGet all promo codes
      Goalsarrow
    • Goals and goal values registration
      Application push notificationsarrow
    • Processing and adding a subscriptionAdd app push events
      Marketarrow
      • Market objectsarrow
      • Order data objectProduct data objectSKU data objectCategories arrayCustom fields array
        Ordersarrow
      • Import order and item statusesGet orders listDelete orderGet order statusUpdate order line status
        Products and SKUarrow
      • Import products, SKUs and categoriesImport SKUs and categoriesGet products listGet SKUs listDelete productsDelete SKU
      Analytic reportsarrow
    • Get summary reportGet soft bounces reportGet undeliveries report
      Sendersarrow
    • Get senders list
        Virtual senders (Smart accounts only)arrow
      • Get virtual senders listGet virtual sender informationClone virtual senderCreate virtual senderUpdate virtual senderDelete virtual sender
      External datatables queriesarrow
      • Segmentation queriesarrow
      • Add segmentation queryUpdate segmentation queryGet segmentation query informationGet segmentation queries listDelete segmentation query
        Template queriesarrow
      • Add template queryUpdate template queryGet template query informationGet template queries listDelete template query
      Objectsarrow
    • AKMTA objectContent objectEmail rule objectFile objectProfile data objectSMS rule objectSender objectSender typesStart schedule objectSubscription objectTrigger types
      Miscellaneousarrow
    • Upload fileGet message web versionPush providersDeduplication of requestsHow to send API request with RabbitMQList of gender identificationsObtain valid values for fields: browsers, devices, tz, oses, languages
    Importing the API collection in PostmanList of API endpoints
      SDKarrow
      • mSDKarrow
        • Androidarrow
        • Quick StartSDK FunctionalitySDK ConfigurationPublic SDK API
            Provider configuration androidarrow
          • Firebase Cloud MessagingHuawei Mobile ServicesRuStore
          iOSarrow
        • Quick StartSDK FunctionalitySDK ConfigurationPublic SDK API
            Provider configurationarrow
          • Apple Push Notification ServiceFirebase Cloud MessagingHuawei Mobile Services
          React Native (Android/iOS)arrow
        • Quick StartSDK ConfigurationSDK FunctionalityPublic SDK APIProvider setup
        Managing JWT and Role Token
  • List of API endpoints

List of API endpoints

Profiles
Import or update profile
Import profile/api/v1.1/profiles/import
Import multiple profiles/api/v1.1/profiles/import_batch
Add profile to database/api/v1.1/profiles/add
Add multiple profiles/api/v1.1/profiles/add_batch
Quick profile import/api/integrations/any/profile_import
Update profile/api/v1.1/profiles/update
Update multiple profiles/api/v1.1/profiles/update_batch
Get profile data/api/v1.1/profiles/get/
Get data for multiple profiles/api/v1.1/profiles/list
Uploading profiles to a file/api/v1.1/profiles/get_all
Delete profile/api/v1.1/profiles/delete
Merging multiple profiles/api/v1.1/profiles/merge
Profile splitting/api/v1.1/profiles/split
Unsubscribe profile from resource/api/v1.1/profiles/message_unsub
Suspend all database profiles/api/v1.0/lists/{list_id}/suspend_all?token={token}
Unsuspend all profiles in a database/api/v1.0/lists/{list_id}/unsuspend_all?token={token}
Action history
Get profile action history/api/v1.1/subscribers/history_get
Get multiple profiles action history/api/v1.1/subscribers/history_get_all
Profile relations
Attach relation/api/v1.1/relations/attach
Detach relation/api/v1.1/relations/detach
Modify relation properties/api/v1.1/relations/strengthen
Overwrite relation propertiesm/api/v1.1/relations/edit
Get profile relations info/api/v1.1/relations/get_counter
Subscriptions
Add or edit subscription/api/v1.1/subscriptions/set
Get all profile subscriptions/api/v1.1/subscriptions/list
Get all subscriptions from multiple profiles/api/v1.1/subscriptions/list_all
Get profile subscription/api/v1.1/subscriptions/get
Delete profile subscription/api/v1.1/subscriptions/delete
Restore deleted subscription/api/v1.1/subscriptions/undelete
Suspend all subscriptions/api/v1.1/subscriptions/suspend_all
Unsuspend all suspended subscriptions/api/v1.1/subscriptions/unsuspend_all
Databases
Get database list/api/v1.1/databases/list
Get database information/api/v1.1/databases/get
Get database fields/api/v1.1/databases/fields_get
Database wipe/api/v1.1/databases/wipe
Resources
Get resources list/api/v1.1/resources/list
Get resource information/api/v1.1/resources/get
Get resource subscription fields/api/v1.1/resources/fields_get
Segments
Managing segments
Create segment/api/v1.1/segments/add
Update segment/api/v1.1/segments/update
Get segment information/api/v1.1/segments/get
Get segments list/api/v1.1/segments/list
Delete segment/api/v1.1/segments/delete
Refresh segment subscription statistics/api/v1.1/segments/refresh_counters
Get profile subscription statistics for a segment/api/v1.1/segments/get_counters
Managing profiles in a static segment
Add profile/api/v1.1/profiles/segstatic/add
Remove profile/api/v1.1/profiles/segstatic/remove
Get profile data in a static segment/api/v1.1/profiles/segstatic/list
Suppression lists
Managing suppression lists
Create suppression list/api/v1.1/suppresses/add
Update suppression list/api/v1.1/suppresses/update
Get suppression list info/api/v1.1/suppresses/get
Get the list of suppression lists/api/v1.1/suppresses/list
Delete suppression list/api/v1.1/suppresses/delete
Upload suppression list data to file/api/v1.1/suppresses/export
Adding, checking and deleting an email address
Check if email is suppressed/api/v1.1/suppresses/email_check
Add email to suppression list/api/v1.1/suppresses/email_add
Add multiple emails to suppression list/api/v1.1/suppresses/emails_add
Remove email from suppression list/api/v1.1/suppresses/email_remove
Remove all emails from suppression list/api/v1.1/suppresses/emails_remove
Adding, checking and deleting an email domain
Check if domain is suppressed/api/v1.1/suppresses/domain_check
Add domain to suppression list/api/v1.1/suppresses/domain_add
Add multiple domains to suppression list/api/v1.1/suppresses/domains_add
Remove domain from suppression list/api/v1.1/suppresses/domain_remove
Remove all domains from suppression list/api/v1.1/suppresses/domains_remove
Adding, checking and deleting a phone number
Check if phone number is suppressed/api/v1.1/suppresses/phone_check
Add phone number to suppression list/api/v1.1/suppresses/phone_add
Add multiple phones to suppression list/api/v1.1/suppresses/phones_add
Remove phone number from suppression list/api/v1.1/suppresses/phone_remove
Remove all phone numbers from suppression list/api/v1.1/suppresses/phones_remove
Templates
Add template/api/v1.1/templates/add
Update template/api/v1.1/templates/update
Get template info/api/v1.1/templates/get
Get templates list/api/v1.1/templates/list
Delete template/api/v1.1/templates/delete
Mailing
Managing mailings
Activate mailing/api/v1.1/campaigns/activate
Deactivate mailing/api/v1.1/campaigns/deactivate
Get mailing information/api/v1.1/campaigns/get
Get mailing status/api/v1.1/campaigns/get_status
Get mailing log/api/v1.1/campaigns/log_v2
Get mailing list/api/v1.1/campaigns/list
Clone mailing/api/v1.1/campaigns/clone
Delete mailing/api/v1.1/campaigns/delete
Broadcast mailings
Create broadcast mailing/api/v1.1/campaigns/broadcasts/add
Update broadcast mailing/api/v1.1/campaigns/broadcasts/update
Launch a broadcast mailing/api/v1.1/campaigns/broadcasts/start
Get broadcast information/api/v1.1/campaigns/broadcasts/get
Get broadcasts list/api/v1.1/campaigns/broadcasts/list
Regular mailings
Create regular mailing/api/v1.1/campaigns/regulars/add
Update regular mailing/api/v1.1/campaigns/regulars/update
Launch a regular mailing/api/v1.1/campaigns/regulars/start
Get regular mailing information/api/v1.1/campaigns/regulars/get
Get regular mailings list/api/v1.1/campaigns/regulars/list
Trigger mailings
Create trigger mailing/api/v1.1/campaigns/triggers/add
Update trigger mailing/api/v1.1/campaigns/triggers/update
Clone a trigger mailing/api/v1.1/campaigns/triggers/clone
Trigger launch (API call)/api/v1.1/campaigns/triggers/start
Bulk trigger launch/api/v1.1/campaigns/triggers/start_batch
Task for bulk trigger launch/api/v1.1/campaigns/triggers/start_batch_task
Profile import + trigger mailing launch/api/v1.1/campaigns/triggers/import_and_start
Bulk profiles import + trigger mailing launch/api/v1.1/campaigns/triggers/import_and_start_batch
Task for bulk profiles import + trigger launch/api/v1.1/campaigns/triggers/import_and_start_batch_task
Get trigger mailing information/api/v1.1/campaigns/triggers/get
Get trigger mailings list/api/v1.1/campaigns/triggers/list
Campaigns
Campaign Management
Get campaign information/api/v1.1/scampaigns/get
Get campaign list/api/v1.1/scampaigns/list
Activate campaign/api/v1.1/scampaigns/activate
Deactivate campaign/api/v1.1/scampaigns/deactivate
Complete campaign/api/v1.1/scampaigns/completed
Get campaign status/api/v1.1/scampaigns/get_status
Automation scenarios
Engage profile in scenario/api/v1.1/workflows/start
Import and engage profile in scenario/api/v1.1/workflows/import_and_start
Batch import and engage profiles in a scenario/api/v1.1/workflows/import_and_start_batch
Task for batch import and engaging profiles in the scenarioй/api/v1.1/workflows/import_and_start_batch_task
Get scenarios list/api/v1.1/workflows/list
Promo codes
Import promo codes/api/v1.1/promocodes/import
Get promo code information/api/v1.1/promocodes/get
Activate promo code/api/v1.1/promocodes/activate
Update promo codeapi/v1.1/promocodes/update
Attach promo code/api/v1.1/promocodes/attach
Detach promo code/api/v1.1/promocodes/detach
Detach promo code/api/v1.1/promocodes/export_all
Loyalty Program
Points and Transactions Management
Get points balance/api/v1.1/loyalty/account/balance
Get profile account transactions/api/v1.1/loyalty/account/transactions
Get expiring points for a period/api/v1.1/loyalty/account/expiring_points
Get profile loyalty tier/api/v1.1/loyalty/account/tiers
Accrue points to member/api/v1.1/loyalty/accrue_points
Redeem member points/api/v1.1/loyalty/redeeme_points
Cancel points transaction/api/v1.1/loyalty/cancel_transaction
Export points transactions/api/v1.1/loyalty/transactions_export
Member Management
Register member in loyalty program/api/v1.1/loyalty/register_member
Delete member from loyalty program/api/v1.1/loyalty/delete_member
Temporary Transactions and Preorders
Get trigger promotions list/api/v1.1/loyalty/trigger_promotions
Preorder/api/v1.1/market/orders/preorder
Confirm order/api/v1.1/market/orders/preorder_commit
Confirm temporary transaction/api/v1.1/loyalty/commit_transaction
Cancel temporary transaction/api/v1.1/loyalty/rollback_transaction
Goals
Goals and goal values registration/api/v1.1/goals/register
Application push notifications
Add app push events/api/v1.1/pushes/post_events
Market
Orders
Import order and item statuses/api/v1.1/market/orders/import
Get orders list/api/v1.1/market/orders/list
Delete order/api/v1.1/market/orders/delete
Update order line status/api/v1.1/market/orders/update_order_line_status
Products and SKU
Import products, SKUs and categories/api/v1.1/market/products/import
Import SKUs and categories/api/v1.1/market/sku/import
Get products list/api/v1.1/market/products/list
Get SKUs list/api/v1.1/market/sku/list
Analytic reports
Get summary report/api/v1.1/reports/summary
Get soft bounces report/api/v1.1/reports/bounces
Get undeliveries report/api/v1.1/reports/undelivered
Senders
Senders list
Get senders list/api/v1.1/senders/list
Virtual senders
Create virtual sender/api/v1.1/vsenders/add
Update virtual sender/api/v1.1/vsenders/update
Get virtual sender information/api/v1.1/vsenders/get
Get virtual senders list/api/v1.1/vsenders/list
Clone virtual sender/api/v1.1/vsenders/clone
Delete virtual sender/api/v1.1/vsenders/delete
External datatables queries
Segmentation queries
Add segmentation query/api/v1.1/datatables/query_segments/add
Update segmentation query/api/v1.1/datatables/query_segments/update
Delete segmentation query/api/v1.1/datatables/query_segments/delete
Get segmentation queries list/api/v1.1/datatables/query_segments/list
Get segmentation query info/api/v1.1/datatables/query_segments/get
Templates queries
Add templates query/api/v1.1/datatables/query_templates/add
Update templates query/api/v1.1/datatables/query_templates/update
Delete templates query/api/v1.1/datatables/query_templates/delete
Get templates queries list/api/v1.1/datatables/query_templates/list
Get templates query info/api/v1.1/datatables/query_templates/get
Miscellaneous
Upload file/api/v1.1/file_upload
Get message web version/api/v1.1/webver/get
Last updated on Mar 12, 2026
Previous
Importing the API collection in Postman
Next
SDK
© 2015 - 2026 Altcraft, LLC. All rights reserved.