Skip to main content

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
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
Campaign
Managing campaigns
Activate campaign/api/v1.1/campaigns/activate
Deactivate campaign/api/v1.1/campaigns/deactivate
Get campaign information/api/v1.1/campaigns/get
Get campaign status/api/v1.1/campaigns/get_status
Get campaign log/api/v1.1/campaigns/log_v2
Get campaign list/api/v1.1/campaigns/list
Clone campaign/api/v1.1/campaigns/clone
Delete campaign/api/v1.1/campaigns/delete
Broadcast campaigns
Create broadcast campaign/api/v1.1/campaigns/broadcasts/add
Update broadcast campaign/api/v1.1/campaigns/broadcasts/update
Launch a broadcast campaign/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 campaigns
Create regular campaign/api/v1.1/campaigns/regulars/add
Update regular campaign/api/v1.1/campaigns/regulars/update
Launch a regular campaign/api/v1.1/campaigns/regulars/start
Get regular campaign information/api/v1.1/campaigns/regulars/get
Get regular campaigns list/api/v1.1/campaigns/regulars/list
Trigger campaigns
Create trigger campaign/api/v1.1/campaigns/triggers/add
Update trigger campaign/api/v1.1/campaigns/triggers/update
Clone a trigger campaign/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 campaign launch/api/v1.1/campaigns/triggers/import_and_start
Bulk profiles import + trigger campaign 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 campaign information/api/v1.1/campaigns/triggers/get
Get trigger campaigns list/api/v1.1/campaigns/triggers/list
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
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