ActiveTrail

Delete a specific category by providing its' ID. via DELETE /api/account/contentCategories/{id}

Delete the given automation. You can delete a few in a bulk if the IDs are seperated with a comma (',') via DELETE /api/automations/{ids}

Delete campaign via DELETE /api/campaigns/{id}

Delete the given Contact via DELETE /api/contacts/{id}

Delete a merge conflict via DELETE /api/contacts/merges/{id}

Delete the given contact by providing external id and external name. If one doesnt match the other or doesn't exist we'll get an error via DELETE /api/external/contact/{externalId}

Delete contacts from group with the given external id and external name via DELETE /api/external/group/{groupId}

Delete contacts from mailing list with the given external id and external name via DELETE /api/external/mailinglist/{mailinglistId}

Unmap contact's external id and name based on the provided details. If one doesnt match the other or doesn't exist you'll get an error via DELETE /api/external/unmap/{externalId}

Delete a given group via DELETE /api/groups/{id}

Remove member from a group via DELETE /api/groups/{id}/members/{memberId}

Delete MailingList via DELETE /api/mailinglist/{id}

Remove member from mailing list via DELETE /api/mailinglist/{id}/members/{memberId}

Delete a given smart Code site via DELETE /api/smartcodesite/{id}

Delete a specific template. via DELETE /api/templates/{id}

Delete the given template category. please note: if you delete a category - all the templates in this category will be deleted as well via DELETE /api/templates/TemplateCategory/{id}

Delete account's social via DELETE /api/user-social/{network}/account/{id}/delete

Delete a Webhook by a given id via DELETE /api/webhooks/{id}

Delete a given Webhook Parameter via DELETE /api/webhooks/{id}/parameters/{parameterid}

Get all the replies for virtual numbers via GET /api/2waysms/getreplies

Get email and SMS credit balance. via GET /api/account/balance

Get the account contact fields filtered by fields' type via GET /api/account/contactFields

Get the account's categories. via GET /api/account/contentCategories

Get a specific category details by providing its' ID. via GET /api/account/contentCategories/{id}

Get executive reports. via GET /api/account/executivereport

Get inactive and active contacts' daily growth filtered by dates (from/to date, the defualt is three months back) via GET /api/account/executivereport/contactgrowth

Get the account's ActiveCommerce integration data. via GET /api/account/integrationdata/activecommerce

Check if the account has awaited merges. via GET /api/account/merge

Get the account emails sending profiles via GET /api/account/sendingprofiles

Get the account Sms sending profiles via GET /api/account/sms-sendingprofiles

Get email campaigns statistics for a specific automation. via GET /api/automationreports/{id}/automationemailscampaignstatistic

Get Push Notification campaigns statistics for a specific automation. via GET /api/automationreports/{id}/automationpushnotificationcampaignstatistic

Get SMS campaigns statistics for a specific automation. via GET /api/automationreports/{id}/automationsmscampaignstatistic

Get Whatsapp campaigns statistics for a specific automation. via GET /api/automationreports/{id}/automationwhatsappcampaignstatistic

Returns the contacts that finished a specific automation via GET /api/automationreports/{id}/ContactsEnded

Returns the contacts that started a specific automation. via GET /api/automationreports/{id}/ContactsStarted

Returns all the contacts that started a specific automation and shows all their steps in the automation. via GET /api/automationreports/{id}/logautomation

Returns all the contacts that did not finish a specific automation via GET /api/automationreports/{id}/logautomationqueue

Returns a summary report for a specific automation via GET /api/automationreports/{id}/OverviewReport

Returns SMS campaigns' summary reports in a specific automation via GET /api/automationreports/{id}/SMSCampaignSummaryReport

Returns email campaigns' summary reports in a specific automation via GET /api/automationreports/{id}/SummaryReport

Get account's automations via GET /api/automations

Get an automation information by its' id via GET /api/automations/{id}

Get the information of a specific A/B split step in the given automation via GET /api/automations/{id}/ABSplitSteps/{stepId}

Get the activation status of the given automation via GET /api/automations/{id}/activation

Getting report details for given step via GET /api/automations/{id}/AutomationStepReportDetails/{stepId}

Get the JSON that represents the design of the automation flow in the UI(excluding automation's steps) via GET /api/automations/{id}/chartData

Get the information of a specific 'contact update' step in the given automation via GET /api/automations/{id}/ContactUpdateSteps/{stepId}

Get trigger's information of a specific "contact celebrates a date" automation. Providing an automation id that has a different trigger will result in an via GET /api/automations/{id}/DateEventTriggerData

Get the JSON that represents the design of the automation flow in the UI including the data of the given automation via GET /api/automations/{id}/design

Get the details (excluding the steps) of a specific automation via GET /api/automations/{id}/details

Get all the 'send email' steps in a given automation via GET /api/automations/{id}/EmailCampaignSteps

Get the information of a specific email step in the given automation via GET /api/automations/{id}/EmailCampaignSteps/{stepId}

Get the automation's steps flow via GET /api/automations/{id}/FlowTimesStarted

Get the information of a specific 'notify someone' step in the given automation via GET /api/automations/{id}/NotifySteps/{stepId}

Get the information of a specific push notification step in the given automation via GET /api/automations/{id}/PushNotificationSteps/{stepId}

Get all the 'send SMS' steps in a given automation via GET /api/automations/{id}/SMSCampaignSteps

Get the information of a specific SMS step in the given automation via GET /api/automations/{id}/SMSCampaignSteps/{stepId}

Get the information of a specific Social step in the given automation via GET /api/automations/{id}/SocialSteps/{stepId}

Get a certain automation step information in the given automation via GET /api/automations/{id}/Steps/{stepId}

Get a specific automation's trigger information via GET /api/automations/{id}/triggerInfo

Get the information of a specific Whatsapp step in the given automation via GET /api/automations/{id}/WhatsAppCampaignSteps/{stepId}

Get all the types of actions that can be updated for a contact in an automation via GET /api/automations/GetUpdateActions

Get all the start trigger options for automations via GET /api/automationtriggers/triggerTypes

Get a full report of your campaigns that include: send date, opens, clicks, CTO, bounces, unsubscribers, complaints, unopened and sent emails. You can get via GET /api/campaignreports

Get an overview report for a specific campaign. You can limit the search to specific time (by default, the search will be for campaigns that were updated in via GET /api/campaignreports/{id}

Get a specific campaign's bounces by bounce type. via GET /api/campaignreports/{id}/bounced

Get campaign's bounces and quantity of bounces per domain. You can limit the search to specific time (by default, the search will be for campaigns that were via GET /api/campaignreports/{id}/bounces

Get a specific campaign browser clients statistics via GET /api/campaignreports/{id}/browsing

Get a click report for a specific campaign. You can limit the search to specific time (by default, the search will be for campaigns that were updated in the via GET /api/campaignreports/{id}/clickdetails

Get a specific link clickdetails. You can limit the search to specific time (by default, the search will be for campaigns that were updated in the last 3 via GET /api/campaignreports/{id}/clickdetails/{linkId}

Get contacts that reported a specific campaign as "spam". You can choose to get all the complaints from a specific group. You can limit the search to specific via GET /api/campaignreports/{id}/complaints

Get a specific campaign's overview reports per domain. via GET /api/campaignreports/{id}/domains

Get all contacts' activity on a specific campaign. You can limit the search to specific time (by default, the search will be for campaigns that were updated via GET /api/campaignreports/{id}/emailactivity

Get campaign openers. You can choose to get all the openers from a specific group. You can limit the search to specific time (by default, the search will be via GET /api/campaignreports/{id}/opens

Get campaign sent emails. You can choose to get all the openers from a specific group. You can limit the search to specific time (by default, the search will via GET /api/campaignreports/{id}/sent

Get contacts that didn't open a specific campaign. You can choose to get all the contacts that didn't open from a specific group. You can limit the search to via GET /api/campaignreports/{id}/unopened

Get all the contacts that unsubscribed in a specific email. You can limit the search to specific time (by default, the search will be for campaigns that were via GET /api/campaignreports/{id}/unsubscribed

Get account's email campaigns. You can get campaigns filtered by various parameters including date and limited to a number of campaigns (you will get via GET /api/campaigns

Get campaign by id via GET /api/campaigns/{id}

Get campaign design via GET /api/campaigns/{id}/design

Get campaign details via GET /api/campaigns/{id}/details

Get campaign schedule via GET /api/campaigns/{id}/scheduling

Get campaign sending settings (groups and sending restrictions). via GET /api/campaigns/{id}/segment

Get campaign template via GET /api/campaigns/{id}/template

Return a list of sent campaigns via GET /api/campaigns/SentCampaigns

Get order by its id. via GET /api/commerce/Order/{orderId}

Get order fields information via GET /api/commerce/schema

Get account's contacts list. You can get the list filtered by customer status (active, unsubscribed, bounced. etc.,) by the state change date (from/to date via GET /api/contacts

Get contact details by contact id via GET /api/contacts/{id}

Get contact's activity on any email that was sent to them via GET /api/contacts/{id}/activity

Get contact's bounces via GET /api/contacts/{id}/errors

Get contact's groups via GET /api/contacts/{id}/groups

Get contact's mailing lists via GET /api/contacts/{id}/mailinglists

Gets contact's statistics for specific campaign via GET /api/contacts/{id}/Statistics/Campaign/{campaignId}

Gets customer statistics for specific operation message via GET /api/contacts/{id}/Statistics/OperationMessage/{messageId}

Gets contact's statistics for specific sms operational message. via GET /api/contacts/{id}/Statistics/SmsOperationMessage/{messageId}

Get account's contacts list. You can get the list filtered by customer status (active, unsubscribed, bounced. etc.,) by the state change date (from/to date via GET /api/contacts/GetWithSmsState

Get contacts in merge conflict via GET /api/contacts/merges

Get a specific merge conflict information via GET /api/contacts/merges/{id}

Get contacts' status and the source of their status (if known). You can filter the endpoint by contacts' creation date (from/to date, the defualt is three via GET /api/contacts/Subscription/AllContacts

Get statistics of contacts' statuses from specific dates. You can choose to get statistics between specific dates (from/to date, the defualt is three months via GET /api/contacts/Subscription/CustomersStatus

Get all subscribers and the source of their status (if known). You can choose to get all subscriptions between specific dates (from/to date, the defualt is via GET /api/contacts/Subscription/Subscribers

Get all unsubscribers and the source of their status (if known). You can choose to get all unsubscription between specific dates (from/to date, the defualt is via GET /api/contacts/Subscription/Unsubscribers

Gets all contacts that are unsubscribed from getting sms messages via GET /api/contacts/unsubscribers/sms

Get the contact list. You can get the list filtered by customer email and/or sms via GET /api/external

Get the list of contacts activities. You can get the list filtered by the status changed date (from/to date, the default is three months back) and limited to via GET /api/external/activity

Get contact by the external id and name. if one doesnt match the other we'll get an empty response. via GET /api/external/{externalId}

Get the list of contacts (those that have external id and external name). You can get the list filtered by customer status (active, unsubscribed, bounced. via GET /api/external/contacts

Get contact's fields information via GET /api/external/schema

Get external email statistics via GET /api/external/statistics/mail

Get external SMS statistics via GET /api/external/statistics/sms

Get the list of unmapped contacts (those that have no external id or external name). You can get the list filtered by customer status (active, unsubscribed via GET /api/external/unmapped

Get account's groups via GET /api/groups

Get group information by id via GET /api/groups/{Id}

Get all group events. You can get the list filtered by event type (opens, clicks, unsubscribes, etc.), by the event date (from/to date, the default is three via GET /api/groups/{id}/events

Get all group members. You can get the list filtered by customer status (active, unsubscribed, bounced. etc.,) by the state change date (from/to date, the via GET /api/groups/{id}/members

Get account's landing pages via GET /api/landingpage

Get account's mailing lists via GET /api/mailinglist

Get MailingList by id via GET /api/mailinglist/{Id}

Get all mailing list's members. You can get the list filtered by customer status (active, unsubscribed, bounced. etc.,) by the state change date (from/to via GET /api/mailinglist/{id}/members

Get classification list via GET /api/OperationalMessage/Classification

Get Push campaigns. You can get Push campaigns filtered (you will get the last 20 campaigns in the last 6 months by default) via GET /api/pushcampaign/Campaign

Get Push campaigns reports . You can get Push campaigns reports filtered (you will get the last 20 campaigns in the last 3 months by default) via GET /api/Pushcampaignreport

Getting the Overview report info of a specific Push campaign. via GET /api/Pushcampaignreport/{id}/{aid}

Getting the delivered report (contacts the campaign was delivered to) of a specific Push campaign. The campaign must be sent in the time range you set using via GET /api/Pushcampaignreport/{id}/Delivered

Getting the failed report (contacts the campaign was sent to but got a delivery failure) of a specific Push campaign. The campaign must be sent in the time via GET /api/Pushcampaignreport/{id}/Failed

Getting the opens report (contacts that opened a campaign) of a specific Push campaign. The campaign must be sent in the time range you set using "from date" via GET /api/Pushcampaignreport/{id}/Opens

Getting the sent report (contacts the campaign was sent to) of a specific Push campaign. The campaign must be sent in the time range you set using "from date" via GET /api/Pushcampaignreport/{id}/Sent

Getting the Summary report info of Push campaigns by dates. (defauly is the last 3 months) via GET /api/Pushcampaignreport/GetSummary

Get lead by its id. via GET /api/salesLifeCycle/Lead/{leadId}

Get opportunity by its id. via GET /api/salesLifeCycle/Opportunity/{opportunityId}

Get list of all user's segmentations via GET /api/segmentation

Get dictionary of rules field types via GET /api/segmentation/ruleFieldTypes

Get dictionary of rules operations via GET /api/segmentation/ruleOperations

Get dictionary of rules field types via GET /api/segmentation/ruleTypes

Get a full mapping of operations and field types associated to the type of rule. via GET /api/segmentation/ruleTypesMapping

Get all your sign-up forms via GET /api/signupforms

Get sign-up form by id via GET /api/signupforms/{id}

Get a list of the account's Smart Code sites via GET /api/smartcodesite

Get account's sms campaigns (including operational sms). You can get campaigns filtered by various parameters including dates and limited to a number of via GET /api/smscampaign/Campaign

Get SMS campaign by id via GET /api/smscampaign/Campaign/{id}

Calculating the estimated number of messages for a given campaign. Can be used only for campaigns that were not sent yet via GET /api/smscampaign/Campaign/{id}/estimate

Get SMS message by id via GET /api/smscampaign/OperationalMessage/{id}

Get SMS campaigns reports . You can get campaigns filtered by various parameters including dates and limited to a number of campaigns (you will get camapigns via GET /api/smscampaignreport

Get a specific SMS campaign summary report via GET /api/smscampaignreport/{id}

Get clickers by link id. If you didn't send the sms to a group but chose the "add numbers manually" function - you'll get the amount of clickers but not the via GET /api/smscampaignreport/{id}/clickdetails/{linkId}

Get all the contacts that clicked on a link sms (can be filtered by specific link). If you didn't send the sms to a group but chose the "add numbers manually" via GET /api/smscampaignreport/{id}/Clickers

Get SMS clicks (on links) reports. via GET /api/smscampaignreport/{id}/Clicks

Get all the contacts that the sms was delivered to. If you didn't send the sms to a group but chose the "add numbers manually" function - you'll get the via GET /api/smscampaignreport/{id}/Delivered

Get all the contacts that the sms wasn't sent to (delivery failure). If you didn't send the sms to a group but chose the "add numbers manually" function via GET /api/smscampaignreport/{id}/Failed

Get all the contacts that the sms was sent to. If you didn't send the sms to a group but chose the "add numbers manually" function - you'll get the amount of via GET /api/smscampaignreport/{id}/Sent

Get all the contacts that unsubscribed from a specific campaign sms. If you didn't send the sms to a group but chose the "add numbers manually" function via GET /api/smscampaignreport/{id}/Unsubscribed

Get SMS campaigns reports . You can get campaigns filtered by various parameters including dates and limited to a number of campaigns (you will get camapigns via GET /api/smscampaignreport/GetSummary

Get account's "my templates" via GET /api/templates

Get a specific template' information via GET /api/templates/{id}

Get a template's content via GET /api/templates/{id}/content

Get "my templates" categories via GET /api/templates/TemplateCategory

Get account's social via GET /api/user-social/accounts/get

Get WhatsApp campaign content (v2) via GET /api/v2/WhatsAppCampaign

Get account's Webhooks information via GET /api/webhooks

Get the Webhook of a given id via GET /api/webhooks/{id}

Get the Webhook Parameters for a given webhook id via GET /api/webhooks/{id}/parameters

Get WhatsApp campaign content via GET /api/WhatsAppCampaign

Get all WhatsApp profiles for the account via GET /api/whatsappcampaign/profiles

Get all approved WhatsApp templates for the user via GET /api/whatsappcampaign/templates

Get a specific WhatsApp template by ID (Sid) via GET /api/whatsappcampaign/templates/{id}

Get WhatsApp campaign content (unversioned path) via GET /WhatsAppCampaign/GetCampaignContent

Create a new category. via POST /api/account/contentCategories

Send test campaigns from the given automation via POST /api/automations/{id}/test

Create and return a new campaign for specific groups. The campaign can be set as an A/B split, E-commerc or a regular campaign. Don't worry, we symplified it via POST /api/campaigns

Create and return a new campaign for specific contacts. The campaign can be set as an A/B split, E-commerc or a regular campaign. Don't worry, we symplified via POST /api/campaigns/Contacts

Add new cart via POST /api/commerce/Cart

Add new order via POST /api/commerce/Order

Create and return a new contact. Please note: if the contact does not exist in the account they will be added but won't be linked to any group - making it via POST /api/contacts

Import contacts to a group. Limited to 1000 contacts per call. via POST /api/contacts/Import

Add contact to group with the given external id and external name. Limited to 1000 contacts per call. via POST /api/external/group/{groupId}

Import contacts. Limited to 1000 contacts. If the external ID you try to import exists - you'll get an error via POST /api/external/import

Add contact to mailing list with the given external id and external name. Limited to 1000 contacts per call. via POST /api/external/mailinglist/{mailinglistId}

Map external id and external name to unmapped contact via POST /api/external/mapping

Create and send a new operational message via POST /api/external/operational/message

Create and send a new operational sms message via POST /api/external/operational/sms_message

Create and return a new Group. via POST /api/groups

Add contact to a specific group. You can set the contact's status. please note: you cannot import a contact in status subscribe if he is inactive on via POST /api/groups/{id}/members

Create and return a new Mailing List. via POST /api/mailinglist

Add a member to a mailing list via POST /api/mailinglist/{id}/members

Send an email operational message to individual contacts (limited to 500 messages). The contacts will be created in your account. via POST /api/OperationalMessage/Contacts

Send an email operational message to individual emails (limited to 500 messages). The emails will be created as contacts in your account. via POST /api/OperationalMessage/Message

Add new Lead via POST /api/salesLifeCycle/Lead

Add new Opportunity via POST /api/salesLifeCycle/Opportunity

Create a new segmentation via POST /api/segmentation

Create a new Smart Code site via POST /api/smartcodesite

Create and return a new SMS campaign via POST /api/smscampaign/Campaign

Create and return a new operational SMS message via POST /api/smscampaign/OperationalMessage

Create and return a new template. via POST /api/templates

Create campaign using a specific template via POST /api/templates/{Id}/campaign

Create and return a new template category. via POST /api/templates/TemplateCategory

Create a new Webhook via POST /api/webhooks

Add a webhook parameter via POST /api/webhooks/{id}/parameters

Send a test request for a given Webhook via POST /api/webhooks/{id}/Test

Send a test request with a given url and parameters via POST /api/webhooks/Test

Creates and sends a new WhatsApp campaign. Important: at a first time message to a contact you must send an approved template (should you have a template to via POST /api/whatsappcampaign/SendCampaign

Creates and sends a new WhatsApp operational message. Important: at a first time message to a contact you must send an approved template (should you have a via POST /api/whatsappcampaign/SendOperationalMessage

Update a specific category details by providing its' ID. via PUT /api/account/contentCategories/{id}

Activate/de-activate a given automation via PUT /api/automations/{id}/activation

Update the setup of the given automation via PUT /api/automations/{id}/details

Update an email campaign step in a given automation via PUT /api/automations/{id}/EmailCampaignSteps/{stepId}

Update an SMS campaign step in the automation via PUT /api/automations/{id}/SMSCampaignSteps/{stepId}

Update a given campaign. Please note: only campaigns that are in a draft mode can be updated. via PUT /api/campaigns/{id}

Update campaign design. Please note: only campaigns that are in draft mode can be updated via PUT /api/campaigns/{id}/design

Update campaign details. Please note: only campaigns that are in draft mode can be updated via PUT /api/campaigns/{id}/details

Update campaign schedule. Please note: only campaigns that are in draft mode can be updated via PUT /api/campaigns/{id}/scheduling

Update campaign sending settings (groups and sending restrictions). Please note: only campaigns that are in draft mode can be updated via PUT /api/campaigns/{id}/segment

Update campaign template. Please note: only campaigns that are in draft mode can be updated via PUT /api/campaigns/{id}/template

Modify existing order via PUT /api/commerce/Order/{orderId}

Update contact details via PUT /api/contacts/{id}

Resolve the given conflict via PUT /api/contacts/merges/{id}

Update the given contact via PUT /api/external/contact/{externalId}

Update a given group via PUT /api/groups/{id}

Modify existing lead via PUT /api/salesLifeCycle/Lead/{leadId}

Modify existing opportunity via PUT /api/salesLifeCycle/Opportunity/{opportunityId}

Update the given segmentation via PUT /api/segmentation/{id}

Updates the exisiting Samrt Code site by site id via PUT /api/smartcodesite/{id}

Update SMS campaign (whether it was sent or not). You can also sent the updated campaign in the process via PUT /api/smscampaign/Campaign/{id}

Update operational SMS messages. Only those who were not sent can be updated via PUT /api/smscampaign/OperationalMessage/{id}

Update a specific template via PUT /api/templates/{id}

Update template's content. via PUT /api/templates/{Id}/content

Update the given template category via PUT /api/templates/TemplateCategory/{id}

Update a Webhook via PUT /api/webhooks/{id}

Update a given Webhook Parameter via PUT /api/webhooks/{id}/parameters/{parameterid}