Communication
Manages communication with customers, including notifications, emails, and messaging.
Asynchronous Communication
When you want to communicate with your customers, you can either send the message right away in real-time or or in asynchronous manner. The communication will be received by customer soon afterward in a deferred manner. Choose this method when the context and relevance of the message and the contents are time insensitive like order related notifications.
Send communication asynchronously
Send communication asynchronously
sendCommunicationAsynchronously
Audience
An audience is dataset that primiraily consists of records containing contact details of customers. This dataset can contain any number of records right from a single record to millions of records, stored in a csv file format. You can link audience with an campaign and send communication to all the emails or phone numbers available through records in the selected audience. Additionally to tailor messaging content to your customer you can add templating variables like first and last name in the same record along with that customers contact details. When a campaign is run, the templating variables and contact details will be picked from all the record in an audience, messaging template will be customised with all the templating variables and communication will be triggered to all available contact details. This resource allows you to create and manage datasets
Get system audiences
Get system audiences
getSystemAudiences
Get all the audiences
Get all the audiences
getAudiences
Create an audience
Create an audience
createAudience
Get an audience
Get an audience
getAudienceById
Update an audience
Update an audience
updateAudienceById
Delete an audience
Delete an audience
deleteAudienceById
Get dummy data sources
Get dummy data sources
getDummyDatasources
Get dummy data sources metadata
Get dummy data sources metadata
getDummyDatasourcesMeta
Get N sample records of a CSV
Get N sample records of a CSV
getNSampleRecordsFromCsvByGet
Get N sample records of a CSV
Get N sample records of a CSV
getNSampleRecordsFromCsv
Campaign
Campaigns are used to send message or content in the form of email or SMS message text to large number of people. These campaigns are generally part of marketing or advertisement promotions that are sent to customers. Campaigns can range in size from a few hundred recipients to millions of recipients. A campaign requires a message template i.e an email or sms template , a audience which is a dataset about customer contact details and templating variables to be added in messaging template and a messaging provider. This resource gives an interface for creating new campaigns, managing existing ones and scheduling it. You can also change configurations of existing campaign like changing messaging template, selected messaging provider ot the campaigns recipents.
Get all campaigns
Get all campaigns
getCampaigns
Create a campaign
Create a campaign
createCampaign
Get a campaign
Get a campaign
getCampaignById
Update a campaign
Update a campaign
updateCampaignById
Get campaign statistics
Get campaign statistics
getStatsOfCampaignById
Get BigQuery row count
Get BigQuery row count
getBigQueryRowCountById
Create a BigQuery row count
Create a BigQuery row count
createBigQueryRowCount
Get BigQuery headers
Get BigQuery headers
getBigQueryHeadersById
Create BigQuery N-count
Create BigQuery N-count
createBigQueryNCount
Create BigQuery headers
Create BigQuery headers
createBigQueryHeaders
Get all campaign jobs
Get all campaign jobs
getJobs
Create a campaign jobs
Create a campaign jobs
createJobs
Trigger a campaign job
Trigger a campaign job
triggerCampaignJob
Get logs of all campaign job
Get logs of all campaign job
getJobLogs
Email Template
To send a email communication to your customer you need a email template. A email template consists of a template definition, which is stored in the form of html making it highly customisable and tailor made to descibe a customer journey. This html definition can also be made dynamic by making use of variables through jinja templating. Along with html definition there are more options available for better managing multiple email templates like name and desctiption of email template and tags which are labels used to group similar templates. This resource gives can be used to add new email template as well as editing the contents and definitions of existing ones.
Get all email templates
Get all email templates
getEmailTemplates
Creat an email template
Creat an email template
createEmailTemplate
Get all system email templates
Get all system email templates
getSystemEmailTemplates
Get an email template
Get an email template
getEmailTemplateById
Update an email template
Update an email template
updateEmailTemplateById
Delete an email template
Delete an email template
deleteEmailTemplateById
Get all subscribed email templates
Get all subscribed email templates
getSubscribedEmailTemplates
Events
An Event is a specific scenario that is responsible for dispatching certain actions. An event occurs when ertain conditions are satisfied like an order is placed or an order is canceled for a specific product. When you want to communicate with your customers for certain special scenarios you can use events. You can link an email and/or a sms depending on the event and when that event is triggered, the linked email and/or sms template will be sent to the customer. With this resource you can add new events and delete events. you can also choose whether you want to subscribe to a particular event. By subscribing to an event you opt in to recieve all communications for that event.
Get all event subscriptions
Get all event subscriptions
getEventSubscriptions
Create an event subscription
Create an event subscription
createEventSubscriptions
Get an event subscription
Get an event subscription
getEventSubscriptionsById
Update an event subscriptions
Update an event subscriptions
editEventSubscriptions
Delete an event subscriptions
Delete an event subscriptions
deleteEventSubscriptionsById
Create event subscriptions in bulk
Create event subscriptions in bulk
createEventSubscriptionsByBulk
Global Variables
Variables are used in email and sms templates to make them dynamic and tailored to customer. There are variables that are available for an event called event variables which can be used for a particular template linked to that event like shipment id and order id for oms related events, OTP for authentication events as well as custom user defined variables called as global variables. Users and Admin can create and edit these global variables and use them as templating variables. Global variables contain two types of variables, read only variables and editable variables. For editable global variables there are no predefined values and you can add as many variables as you want. For read only variables there are fixed set of variables that cannot be modified, added or removed like for example company domain or social media handles and support contact details. Use this resource to add, remove and edit editable global variables.
Get all global variables
Get all global variables
getGlobalVariables
Create global variables
Create global variables
postGlobalVariables
OTP
One time passwords(OTP) are an easy an secure way to authenticate customers. OTP is a secret codeword which is randomly generated and sent to customer over email or SMS communication. The customer in response shares this code back and authenticates themselves. Using this resource you can make use of OTP engine which is responsible for generating a OTP plus sending it to a customer and verifying the OTP sent by the customer. There are multiple option available with using this service like what template is to be send or which messaging provider is to be selected as well as some other advanced options available in OTP Configuration Management. By using OTP Configuration Manager you can set the way in which otp should be generated. you can choose with options like numric only otp or alphanumeric otp and the lenght of the otp. Availabe otp configuration are : options: - Length (4,6,8) - Type (Numeric/Alpha Numeric) - Expiry time etc.
Send OTP
Send OTP
sendOtp
Verify OTP
Verify OTP
verfiyOtp
Get configuration of otp
Get configuration of otp
getOtpConfiguration
Update configuration of otp
Update configuration of otp
updateOtpConfiguration
Provider
To send communications to your customers, you'll require a messaging service provider. With this provider resource, you can add new provider integrations and manage both new and existing integrations along with their configurations along with default settings which defines what provider will always be used . With this resource, you have the flexibility to add various email providers such as SMTP, Pepipost, Falconide and SMS providers like Netcore, SMPP, Telspiel,Viva Connect, Times Internet. You also have option to change the default provide to a custom integration across transaction, OTP and promotional categories for both email and SMS.
Get application providers
Get application providers
getAppProviders
Update application providers
Update application providers
updateAppProviders
Get global providers
Get global providers
getGlobalProviders
Get all email providers
Get all email providers
getEmailProviders
Create an email provider
Create an email provider
createEmailProvider
Get a email provider
Get a email provider
getEmailProviderById
Update email provider
Update email provider
updateEmailProviderById
Delete an email provider
Delete an email provider
deleteEmailProviderById
Get all SMS providers
Get all SMS providers
getSmsProviders
Create SMS provider
Create SMS provider
createSmsProvider
Get all default SMS providers
Get all default SMS providers
getDefaultSmsProviders
Get a SMS provider
Get a SMS provider
getSmsProviderById
Update SMS provider
Update SMS provider
updateSmsProviderById
Delete an SMS provider
Delete an SMS provider
deleteSmsProviderById
Reports
Communication Reports are records that provide information about all the communications across a sales channel. A report encompasses all details concerning email and SMS communication, including status (such as delivery confirmation), error codes, and error messages associated with any errors encountered. Use this resource to get all reports within a specified date range. You also have options to filter based on different parameters. filters available: - communication type(email, sms, both) - email address / phone number - status(error/success) - date range - template id - job id - campaign id
Get communication reports
Get communication reports
getCommunicationLogs
SMS Template
To send a SMS communication to your customer you need a SMS template. A SMS template consists of a template definition, which is stored in the form of html making it highly customisable and tailor made to descibe a customer journey. This html definition can also be made dynamic by making use of variables through jinja templating. Along with html definition there are more options available for better managing multiple SMS templates like name and desctiption of email template and tags which are labels used to group similar templates. This resource gives can be used to add new SMS template as well as edititing the contents and definitions of existing ones.
Get all SMS templates
Get all SMS templates
getSmsTemplates
Create a SMS template
Create a SMS template
createSmsTemplate
Gets all system SMS templates
Gets all system SMS templates
getSystemSmsTemplates
Get a SMS template
Get a SMS template
getSmsTemplateById
Update a SMS template
Update a SMS template
updateSmsTemplateById
Delete an SMS template
Delete an SMS template
deleteSmsTemplateById
Get all subscribed SMS templates
Get all subscribed SMS templates
getSubscribedSmsTemplates
Synchronous Communication
When you want to communicate with your customers, you can either send the message right away in real-time or in asynchronous or batched manner. This method will directly call the messaging service provider in a synchronous manner, making it ideal for time critical functions. Choose this method when the operation is time sensitive, such as for authentication events.
Send communication synchronously
Send communication synchronously
sendCommunicationSynchronously
System Notifications
Notification are the important alerts that appear on top right corner of the platform. These will generally display any alerts that you wish to highlight to Platform users of company and sales channel like store is verified. This resource allows you to edit notification related information such as its content and appearance, and moreover schedule it to appear on platform.