Skip to main content

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.

Operations
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/engine/send-async
# Send communication asynchronously
POST

Send communication asynchronously

Sends communications to sellers with deffered delivery.
Parameters
body
object (EngineRequest)
Pass the api payload as shown below.
EngineRequest
payload
object (PayloadStructure)
Optional
PayloadStructure
meta
object (MetaStructure)
Optional
MetaStructure
Response
200
Success
EngineResponse
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/engine/send-async
Loading...
Response
Example response not available.

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

Operations
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/system-datasources
# Get system audiences
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources
# Get all the audiences
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources
# Create an audience
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources/{id}
# Get an audience
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources/{id}
# Update an audience
DEL
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources/{id}
# Delete an audience
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources/dummy-data-sources
# Get dummy data sources
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources/dummy-data-sources-meta/{id}
# Get dummy data sources metadata
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/get-n-records
# Get N sample records of a CSV
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/get-n-records
# Get N sample records of a CSV
GET

Get system audiences

Deprecated
Retrieves a list of system-defined audiences for communication.
Parameters
No Parameters
Response
200
Success
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/system-datasources
Loading...
Response
Loading...
GET

Get all the audiences

Retrieves a list of all the audiences.
Parameters
pageNo
integer
| value > 1
Optional
Current page no
pageSize
integer
Optional
Current request items count
sort
object
Optional
To sort based on created_at
query
object
Optional
To search based on plain text
Response
200
500
Success
Audiences
items
array of object (Audience)
Optional
Array of Audience
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources
Loading...
Response
Example response not available.
POST

Create an audience

Creates a new email audience.
Parameters
body
object (AudienceReq)
AudienceReq
name
string
Optional
description
string
Optional
tags
array of string
Optional
file_url
string
Optional
type
string
Optional
records_count
integer
| int32
Optional
headers
array of string
Optional
Response
200
500
Refer `Audience` schema for more details.
Audience
_id
string
Optional
application
string
Optional
name
string
Optional
description
string
Optional
records_count
integer
| int32
Optional
type
string
Optional
tags
array of string
Optional
headers
array of string
Optional
file_url
string
Optional
is_active
boolean
Optional
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources
Loading...
Response
Example response not available.
GET

Get an audience

Retrieves detailed information about an specific audience.
Parameters
id
string
Audience id
Response
200
404
500
Refer `Audience` schema for more details.
Audience
_id
string
Optional
application
string
Optional
name
string
Optional
description
string
Optional
records_count
integer
| int32
Optional
type
string
Optional
tags
array of string
Optional
headers
array of string
Optional
file_url
string
Optional
is_active
boolean
Optional
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources/{id}
Loading...
Response
Example response not available.
PUT

Update an audience

Modify the configuration of a specific audience.
Parameters
id
string
Audience id
body
object (AudienceReq)
AudienceReq
name
string
Optional
description
string
Optional
tags
array of string
Optional
file_url
string
Optional
type
string
Optional
records_count
integer
| int32
Optional
headers
array of string
Optional
Response
200
404
500
Refer `Audience` schema for more details.
Audience
_id
string
Optional
application
string
Optional
name
string
Optional
description
string
Optional
records_count
integer
| int32
Optional
type
string
Optional
tags
array of string
Optional
headers
array of string
Optional
file_url
string
Optional
is_active
boolean
Optional
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources/{id}
Loading...
Response
Example response not available.
DEL

Delete an audience

Remove a specific audience permenantly.
Parameters
id
string
Audience id
body
object (AudienceReq)
AudienceReq
name
string
Optional
description
string
Optional
tags
array of string
Optional
file_url
string
Optional
type
string
Optional
records_count
integer
| int32
Optional
headers
array of string
Optional
Response
200
404
500
Refer `Audience` schema for more details.
Audience
_id
string
Optional
application
string
Optional
name
string
Optional
description
string
Optional
records_count
integer
| int32
Optional
type
string
Optional
tags
array of string
Optional
headers
array of string
Optional
file_url
string
Optional
is_active
boolean
Optional
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
body:
body
Was this section helpful?
DEL
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources/{id}
Loading...
Response
Example response not available.
GET

Get dummy data sources

Retrieve a list of dummy data sources.
Parameters
No Parameters
Response
200
500
Refer `DummyDatasources` schema for more details.
Array of DummyDatasources
id
integer
| int32
Optional
name
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources/dummy-data-sources
Loading...
Response
Example response not available.
GET

Get dummy data sources metadata

Retrieve metadata information about dummy data sources.
Parameters
id
integer
| int32
Dummy datasources meta ID
Response
200
500
Refer `DummyDatasourcesMeta` schema for more details.
DummyDatasourcesMeta
id
integer
| int32
Optional
data
object (DummyDatasourcesMetaObj)
Optional
DummyDatasourcesMetaObj
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources/dummy-data-sources-meta/{id}
Loading...
Response
Example response not available.
GET

Get N sample records of a CSV

Retrieve a specified number of sample records from a CSV data source.
Parameters
No Parameters
Response
200
500
Refer `GetNRecordsCsvRes` schema for more details.
GetNRecordsCsvRes
items
array of object (GetNRecordsCsvResItems)
Optional
Array of GetNRecordsCsvResItems
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/get-n-records
Loading...
Response
Example response not available.
POST

Get N sample records of a CSV

Retrieve a specified number of sample records from a CSV data source.
Parameters
body
object (GetNRecordsCsvReq)
GetNRecordsCsvReq
url
string
Optional
header
boolean
Optional
count
integer
| int32
Optional
Response
200
500
Refer `GetNRecordsCsvRes` schema for more details.
GetNRecordsCsvRes
items
array of object (GetNRecordsCsvResItems)
Optional
Array of GetNRecordsCsvResItems
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/get-n-records
Loading...
Response
Example response not available.

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.

Operations
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns
# Get all campaigns
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns
# Create a campaign
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns/{id}
# Get a campaign
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns/{id}
# Update a campaign
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/get-stats/{id}
# Get campaign statistics
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/bigquery-row-count/{id}
# Get BigQuery row count
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/bigquery-row-count
# Create a BigQuery row count
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/bigquery-headers/{id}
# Get BigQuery headers
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/bigquery-n-records
# Create BigQuery N-count
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/bigquery-headers
# Create BigQuery headers
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/jobs
# Get all campaign jobs
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/jobs
# Create a campaign jobs
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/trigger-job
# Trigger a campaign job
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/logs
# Get logs of all campaign job
GET

Get all campaigns

Retrieves a list of communication campaigns.
Parameters
query
object
Optional
To search based on plain text
pageNo
integer
Optional
Current page no
pageSize
integer
Optional
Current request items count
sort
object
Optional
To sort based on created_at
Properties
created_at
integer
Optional
Response
200
Success
Campaigns
items
array of object (Campaign)
Optional
Array of Campaign
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns
Loading...
Response
Example response not available.
POST

Create a campaign

Creates a new communication campaign.
Parameters
body
object (CampaignReq)
CampaignReq
description
string
Optional
tags
array of string
Optional
headers
array of string
Optional
is_active
boolean
Optional
name
string
Optional
file_url
string
Optional
type
string
Optional
records_count
integer
| int32
Optional
application
string
Optional
Response
200
Success
Campaign
recipient_headers
object (RecipientHeaders)
Optional
RecipientHeaders
email
object (CampaignEmail)
Optional
CampaignEmail
description
string
Optional
tags
array of Undefined Type
Optional
is_active
boolean
Optional
_id
string
Optional
datasource
string
Optional
type
string
Optional
name
string
Optional
application
string
Optional
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns
Loading...
Response
Example response not available.
GET

Get a campaign

Retrieves detailed information about a specific communication campaign.
Parameters
id
string
Campaign id
Response
200
404
Success
Campaign
recipient_headers
object (RecipientHeaders)
Optional
RecipientHeaders
email
object (CampaignEmail)
Optional
CampaignEmail
description
string
Optional
tags
array of object
Optional
is_active
boolean
Optional
_id
string
Optional
datasource
string
Optional
type
string
Optional
name
string
Optional
application
string
Optional
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns/{id}
Loading...
Response
Example response not available.
PUT

Update a campaign

Modify the configuration of a specific communication campaign.
Parameters
id
string
Campaign id
body
object (CampaignReq)
CampaignReq
description
string
Optional
tags
array of string
Optional
headers
array of string
Optional
is_active
boolean
Optional
name
string
Optional
file_url
string
Optional
type
string
Optional
records_count
integer
| int32
Optional
application
string
Optional
Response
200
404
Success
Campaign
recipient_headers
object (RecipientHeaders)
Optional
RecipientHeaders
email
object (CampaignEmail)
Optional
CampaignEmail
description
string
Optional
tags
array of object
Optional
is_active
boolean
Optional
_id
string
Optional
datasource
string
Optional
type
string
Optional
name
string
Optional
application
string
Optional
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns/{id}
Loading...
Response
Example response not available.
GET

Get campaign statistics

Retrieves statistical data for a specific a communication campaign.
Parameters
id
string
Campaign id
Response
200
400
Success
GetStats
items
array of object (Stats)
Optional
Array of Stats
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/get-stats/{id}
Loading...
Response
Example response not available.
GET

Get BigQuery row count

Deprecated
Retrieves big query row count by id
Parameters
id
string
Audience id
Response
200
Success
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/bigquery-row-count/{id}
Loading...
Response
Loading...
POST

Create a BigQuery row count

Deprecated
Creates big query row count
Parameters
No Parameters
Response
200
Success
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/bigquery-row-count
Loading...
Response
Loading...
GET

Get BigQuery headers

Deprecated
Retrieves header information from BigQuery.
Parameters
id
string
Audience id
Response
200
Success
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/bigquery-headers/{id}
Loading...
Response
Loading...
POST

Create BigQuery N-count

Deprecated
Creates big query n count
Parameters
No Parameters
Response
200
Success
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/bigquery-n-records
Loading...
Response
Loading...
POST

Create BigQuery headers

Deprecated
Create BigQuery headers
Parameters
No Parameters
Response
200
Success
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/bigquery-headers
Loading...
Response
Loading...
GET

Get all campaign jobs

Retrieves a list of campaign jobs.
Parameters
pageNo
integer
| value > 1
Optional
Current page no
pageSize
integer
Optional
Current request items count
sort
object
Optional
To sort based on created_at
query
object
Optional
To search based on plain text
Response
200
Success
Jobs
items
array of object (Job)
Optional
Array of Job
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/jobs
Loading...
Response
Example response not available.
POST

Create a campaign jobs

Creates a new campaign job.
Parameters
body
object (CreateJobsReq)
CreateJobsReq
campaign
string
Optional
Response
200
Success
CreateJobsRes
application
string
Optional
campaign
string
Optional
completed
boolean
Optional
is_active
boolean
Optional
_id
string
Optional
created_at
string
Optional
updated_at
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/jobs
Loading...
Response
Example response not available.
POST

Trigger a campaign job

Initiates a job to execute a communication campaign.
Parameters
body
object (TriggerJobRequest)
TriggerJobRequest
job_id
string
Optional
Response
200
Success
TriggerJobResponse
status
integer
| int32
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/trigger-job
Loading...
Response
Example response not available.
GET

Get logs of all campaign job

Retrieve logs and details related to campaign jobs.
Parameters
pageNo
integer
| value > 1
Optional
Current page no
pageSize
integer
Optional
Current request items count
sort
object
Optional
To sort based on created_at
query
object
Optional
To search based on plain text
Response
200
Success
JobLogs
items
array of object (JobLog)
Optional
Array of JobLog
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/logs
Loading...
Response
Example response not available.

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.

Operations
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates
# Get all email templates
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates
# Creat an email template
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/system-templates
# Get all system email templates
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates/{id}
# Get an email template
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates/{id}
# Update an email template
DEL
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates/{id}
# Delete an email template
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/subscribedTemplates
# Get all subscribed email templates
GET

Get all email templates

Retrieves a list of available email communication templates.
Parameters
pageNo
integer
| value > 1
Optional
Current page no
pageSize
integer
Optional
Current request items count
sort
object
Optional
To sort based on created_at
query
object
Optional
To search based on plain text
Response
200
500
Refer `EmailTemplates` schema for more details.
EmailTemplates
items
array of object (EmailTemplate)
Optional
Array of EmailTemplate
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates
Loading...
Response
Example response not available.
POST

Creat an email template

Creates a new email communication template.
Parameters
body
object (EmailTemplateReq)
EmailTemplateReq
name
string
description
string
Optional
from_name
string
Optional
static_to
array of string
Optional
static_cc
array of string
Optional
static_bcc
array of string
Optional
reply_to
string
Optional
priority
string
Optional
Enum
tags
array of string
Optional
template_variables
object
Optional
published
boolean
Optional
subject
object (TemplateAndType)
Optional
TemplateAndType
html
object (TemplateAndType)
Optional
TemplateAndType
editor_type
string
Optional
editor_meta
string
Optional
attachments
array of integer
Optional
headers
array of object (EmailTemplateHeaders)
Optional
Array of EmailTemplateHeaders
keys
object (EmailTemplateKeys)
Optional
EmailTemplateKeys
text
object (TemplateAndType)
Optional
TemplateAndType
Response
200
500
Refer `EmailTemplate` schema for more details.
EmailTemplate
application
string
Optional
is_system
boolean
Optional
is_internal
boolean
Optional
name
string
Optional
description
string
Optional
editor_type
string
Optional
editor_meta
string
Optional
static_to
array of string
Optional
static_cc
array of string
Optional
static_bcc
array of string
Optional
reply_to
string
Optional
tags
array of string
Optional
subject
object (TemplateAndType)
Optional
TemplateAndType
html
object (TemplateAndType)
Optional
TemplateAndType
url_shorten
object (EnabledObj)
Optional
EnabledObj
priority
string
Optional
Enum
template_variables
object
Optional
published
boolean
Optional
category
string
Optional
Enum
_id
string
Optional
headers
array of object (EmailTemplateHeaders)
Optional
Array of EmailTemplateHeaders
attachments
array of integer
Optional
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
from_name
string
Optional
text
object (TemplateAndType)
Optional
TemplateAndType
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates
Loading...
Response
Example response not available.
GET

Get all system email templates

Retrieves system-defined email communication templates.
Parameters
No Parameters
Response
200
500
Refer `SystemEmailTemplates` schema for more details.
SystemEmailTemplates
items
array of object (SystemEmailTemplate)
Optional
Array of SystemEmailTemplate
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/system-templates
Loading...
Response
Example response not available.
GET

Get an email template

Retrieves detailed information about a specific email communication template.
Parameters
id
string
Email template id
Response
200
400
404
500
Refer `EmailTemplate` schema for more details.
EmailTemplate
application
string
Optional
is_system
boolean
Optional
is_internal
boolean
Optional
name
string
Optional
description
string
Optional
editor_type
string
Optional
editor_meta
string
Optional
static_to
array of string
Optional
static_cc
array of string
Optional
static_bcc
array of string
Optional
reply_to
string
Optional
tags
array of string
Optional
subject
object (TemplateAndType)
Optional
TemplateAndType
html
object (TemplateAndType)
Optional
TemplateAndType
url_shorten
object (EnabledObj)
Optional
EnabledObj
priority
string
Optional
Enum
template_variables
object
Optional
published
boolean
Optional
category
string
Optional
Enum
_id
string
Optional
headers
array of object (EmailTemplateHeaders)
Optional
Array of EmailTemplateHeaders
attachments
array of integer
Optional
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
from_name
string
Optional
text
object (TemplateAndType)
Optional
TemplateAndType
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates/{id}
Loading...
Response
Example response not available.
PUT

Update an email template

Modifys the content and settings of a specific email communication template.
Parameters
id
string
Email template id
body
object (EmailTemplateReq)
EmailTemplateReq
name
string
description
string
Optional
from_name
string
Optional
static_to
array of string
Optional
static_cc
array of string
Optional
static_bcc
array of string
Optional
reply_to
string
Optional
priority
string
Optional
Enum
tags
array of string
Optional
template_variables
object
Optional
published
boolean
Optional
subject
object (TemplateAndType)
Optional
TemplateAndType
html
object (TemplateAndType)
Optional
TemplateAndType
editor_type
string
Optional
editor_meta
string
Optional
attachments
array of integer
Optional
headers
array of object (EmailTemplateHeaders)
Optional
Array of EmailTemplateHeaders
keys
object (EmailTemplateKeys)
Optional
EmailTemplateKeys
text
object (TemplateAndType)
Optional
TemplateAndType
Response
200
400
404
500
Refer `EmailTemplate` schema for more details.
EmailTemplate
application
string
Optional
is_system
boolean
Optional
is_internal
boolean
Optional
name
string
Optional
description
string
Optional
editor_type
string
Optional
editor_meta
string
Optional
static_to
array of string
Optional
static_cc
array of string
Optional
static_bcc
array of string
Optional
reply_to
string
Optional
tags
array of string
Optional
subject
object (TemplateAndType)
Optional
TemplateAndType
html
object (TemplateAndType)
Optional
TemplateAndType
url_shorten
object (EnabledObj)
Optional
EnabledObj
priority
string
Optional
Enum
template_variables
object
Optional
published
boolean
Optional
category
string
Optional
Enum
_id
string
Optional
headers
array of object (EmailTemplateHeaders)
Optional
Array of EmailTemplateHeaders
attachments
array of integer
Optional
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
from_name
string
Optional
text
object (TemplateAndType)
Optional
TemplateAndType
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates/{id}
Loading...
Response
Example response not available.
DEL

Delete an email template

Removes a specific email communication template from the platform permenantly.
Parameters
id
string
Email template id
Response
200
400
404
500
Refer `GenericDelete` schema for more details.
GenericDelete
message
string
Optional
acknowledged
boolean
Optional
affected
integer
| int32
Optional
operation
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates/{id}
Loading...
Response
Example response not available.
GET

Get all subscribed email templates

Retrieves a list of email communication templates that are subscribed to an event.
Parameters
pageNo
integer
| value > 1
Optional
Current page no
pageSize
integer
Optional
Current request items count
query
object
Optional
To search based on plain text
Response
200
500
Refer `EmailTemplates` schema for more details.
EmailTemplates
items
array of object (EmailTemplate)
Optional
Array of EmailTemplate
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/subscribedTemplates
Loading...
Response
Example response not available.

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.

Operations
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions
# Get all event subscriptions
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions
# Create an event subscription
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions/{id}
# Get an event subscription
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions/{id}
# Update an event subscriptions
DEL
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions/{id}
# Delete an event subscriptions
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions/bulkUpdate
# Create event subscriptions in bulk
GET

Get all event subscriptions

Retrieves a list of all event subscriptions.
Parameters
pageNo
integer
| value > 1
Optional
Current page no
pageSize
integer
Optional
Current request items count
populate
string
Optional
Populate Fields
Response
200
404
500
Success
EventSubscriptions
items
array of object (EventSubscription)
Optional
Array of EventSubscription
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions
Loading...
Response
Example response not available.
POST

Create an event subscription

Creates a new event subscription.
Parameters
body
object (SubscriptionsObject)
SubscriptionsObject
_id
string
Optional
Subscription ID
template
object (TemplateObject)
Optional
TemplateObject
Response
200
404
500
Success
EventSubscriptionsBulkUpdateResponse
template
object (EventSubscriptionTemplate)
Optional
EventSubscriptionTemplate
_id
string
Optional
application
string
Optional
event
string
Optional
slug
string
Optional
category
string
Optional
Enum
created_at
string
Optional
updated_at
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions
Loading...
Response
Example response not available.
GET

Get an event subscription

Retrieves detailed information about a specific event subscription.
Parameters
id
string
Event subscription id
populate
string
Optional
Populate Fields
Response
200
404
500
Success
EventSubscription
template
object (EventSubscriptionTemplate)
Optional
EventSubscriptionTemplate
is_default
boolean
Optional
_id
string
Optional
application
string
Optional
event
string
Optional
slug
string
Optional
created_at
string
Optional
updated_at
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions/{id}
Loading...
Response
Example response not available.
PUT

Update an event subscriptions

Modifys the configuration and settings of a specific event subscription.
Parameters
id
string
Event subscription id
body
object (SubscriptionsObject)
SubscriptionsObject
_id
string
Optional
Subscription ID
template
object (TemplateObject)
Optional
TemplateObject
Response
200
404
500
Success
EventSubscriptionsBulkUpdateResponse
template
object (EventSubscriptionTemplate)
Optional
EventSubscriptionTemplate
_id
string
Optional
application
string
Optional
event
string
Optional
slug
string
Optional
category
string
Optional
Enum
created_at
string
Optional
updated_at
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions/{id}
Loading...
Response
Example response not available.
DEL

Delete an event subscriptions

Removes a specific event subscription from the platform permenantly.
Parameters
id
string
Event subscription id
Response
200
404
500
Refer `GenericDelete` schema for more details.
GenericDelete
message
string
Optional
acknowledged
boolean
Optional
affected
integer
| int32
Optional
operation
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions/{id}
Loading...
Response
Example response not available.
POST

Create event subscriptions in bulk

Creates a new event subscription in bulk.
Parameters
body
object (EventSubscriptionsBulkUpdateRequest)
EventSubscriptionsBulkUpdateRequest
subscriptions
array of object (SubscriptionsObject)
Optional
Array of SubscriptionsObject
Response
200
404
500
Success
Array of EventSubscriptionsBulkUpdateResponse
template
object (EventSubscriptionTemplate)
Optional
EventSubscriptionTemplate
_id
string
Optional
application
string
Optional
event
string
Optional
slug
string
Optional
category
string
Optional
Enum
created_at
string
Optional
updated_at
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions/bulkUpdate
Loading...
Response
Example response not available.

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.

Operations
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/global-variables
# Get all global variables
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/global-variables
# Create global variables
GET

Get all global variables

Retrieves a list of communication global variables.
Parameters
No Parameters
Response
200
500
Refer `GlobalVariablesGetResponse` schema for more details.
GlobalVariablesGetResponse
read_only
object
Optional
editable
object
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/global-variables
Loading...
Response
Example response not available.
POST

Create global variables

Updates and creates communication global variables.
Parameters
body
object (GlobalVariablesReq)
GlobalVariablesReq
global_variables
object
Optional
Response
200
500
Refer `GlobalVariablesPostResponse` schema for more details.
GlobalVariablesPostResponse
_id
string
Optional
category
string
Optional
Enum
application
string
Optional
global_variables
object
Optional
created_at
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/global-variables
Loading...
Response
Example response not available.

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.

Operations
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/otp/send-otp-comms
# Send OTP
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/otp/verify-otp-comms
# Verify OTP
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/otp/otp-configuration
# Get configuration of otp
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/otp/otp-configuration
# Update configuration of otp
POST

Send OTP

Sends a one-time password (OTP) for authentication or verification.
Parameters
body
object (SendOtpCommsReq)
SendOtpCommsReq
data
object (SendOtpCommsReqData)
Optional
SendOtpCommsReqData
sms
object (SendOtpCommsReqSms)
Optional
SendOtpCommsReqSms
email
object (SendOtpCommsReqEmail)
Optional
SendOtpCommsReqEmail
Response
200
Success
SendOtpCommsRes
sms
object (SendOtpCommsResSms)
Optional
SendOtpCommsResSms
email
object (SendOtpCommsResEmail)
Optional
SendOtpCommsResEmail
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/otp/send-otp-comms
Loading...
Response
Example response not available.
POST

Verify OTP

Verifies the one-time password (OTP) for authentication or verification.
Parameters
body
object (VerifyOtpCommsReq)
VerifyOtpCommsReq
request_id
string
Optional
otp
string
Optional
Response
200
400
Success
VerifyOtpCommsSuccessRes
success
boolean
Optional
mobile
string
Optional
country_code
string
Optional
message
string
Optional
email
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/otp/verify-otp-comms
Loading...
Response
Example response not available.
GET

Get configuration of otp

Retrieves all configurations related to OTP.
Parameters
No Parameters
Response
200
Success
OtpConfiguration
otp_length
integer
Enum
type
string
Enum
expiry
object (OtpConfigurationExpiry)
OtpConfigurationExpiry
application_id
string
Optional
company_id
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/otp/otp-configuration
Loading...
Response
Example response not available.
PUT

Update configuration of otp

Updates all configurations related to OTP.
Parameters
No Parameters
Response
200
Success
OtpConfiguration
otp_length
integer
Enum
type
string
Enum
expiry
object (OtpConfigurationExpiry)
OtpConfigurationExpiry
application_id
string
Optional
company_id
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/otp/otp-configuration
Loading...
Response
Example response not available.

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.

Operations
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/app-provider/get-provider
# Get application providers
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/app-provider/update-provider
# Update application providers
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/app-provider/global-providers
# Get global providers
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers
# Get all email providers
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers
# Create an email provider
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers/{id}
# Get a email provider
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers/{id}
# Update email provider
DEL
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers/{id}
# Delete an email provider
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers
# Get all SMS providers
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers
# Create SMS provider
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/default-providers
# Get all default SMS providers
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers/{id}
# Get a SMS provider
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers/{id}
# Update SMS provider
DEL
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers/{id}
# Delete an SMS provider
GET

Get application providers

Retrieve a list of providers associated with the sales channel.
Parameters
No Parameters
Response
200
Success
AppProvider
email
object (AppProviderRes)
Optional
AppProviderRes
sms
object (AppProviderRes)
Optional
AppProviderRes
voice
object (AppProviderResVoice)
Optional
AppProviderResVoice
_id
string
Optional
application
string
Optional
created_at
string
Optional
updated_at
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/app-provider/get-provider
Loading...
Response
Example response not available.
POST

Update application providers

Modify provider configuration using provider object id .
Parameters
body
object (AppProviderReq)
Optional
AppProviderReq
email
object (AppProviderRes)
Optional
AppProviderRes
sms
object (AppProviderRes)
Optional
AppProviderRes
voice
object (AppProviderResVoice)
Optional
AppProviderResVoice
Response
200
Success
AppProvider
email
object (AppProviderRes)
Optional
AppProviderRes
sms
object (AppProviderRes)
Optional
AppProviderRes
voice
object (AppProviderResVoice)
Optional
AppProviderResVoice
_id
string
Optional
application
string
Optional
created_at
string
Optional
updated_at
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/app-provider/update-provider
Loading...
Response
Example response not available.
GET

Get global providers

Retrieve a list of global communication providers associated with the sales channel..
Parameters
No Parameters
Response
200
Success
GlobalProviders
email
array of object (GlobalProvidersResObj)
Optional
Array of GlobalProvidersResObj
sms
array of object (GlobalProvidersResObj)
Optional
Array of GlobalProvidersResObj
voice
array of object (GlobalProvidersResObj)
Optional
Array of GlobalProvidersResObj
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/app-provider/global-providers
Loading...
Response
Example response not available.
GET

Get all email providers

Retrieves a list of all email communication providers associated with the sales channel..
Parameters
pageNo
integer
| value > 1
Optional
Current page no
pageSize
integer
Optional
Current request items count
sort
object
Optional
To sort based on created_at
query
object
Optional
To search based on plain text
Response
200
500
Success
EmailProviders
items
array of object (EmailProvider)
Optional
Array of EmailProvider
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers
Loading...
Response
Example response not available.
POST

Create an email provider

Creates a new email communication provider.
Parameters
body
object (EmailProviderReq)
EmailProviderReq
name
string
Optional
description
string
Optional
api_key
string
Optional
type
string
Optional
provider
string
Optional
from_address
array of object (EmailProviderReqFrom)
Optional
Array of EmailProviderReqFrom
Response
200
500
Success
EmailProvider
type
string
Optional
provider
string
Optional
from_address
array of object (EmailProviderReqFrom)
Optional
Array of EmailProviderReqFrom
_id
string
Optional
name
string
Optional
description
string
Optional
api_key
string
Optional
application
string
Optional
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers
Loading...
Response
Example response not available.
GET

Get a email provider

Retrieves detailed information about a specific email communication provider.
Parameters
id
string
Email provider id
Response
200
404
500
Success
EmailProvider
type
string
Optional
provider
string
Optional
from_address
array of object (EmailProviderReqFrom)
Optional
Array of EmailProviderReqFrom
_id
string
Optional
name
string
Optional
description
string
Optional
api_key
string
Optional
application
string
Optional
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers/{id}
Loading...
Response
Example response not available.
PUT

Update email provider

Modifys the configurations of a specific email communication provider.
Parameters
id
string
Email provider id
body
object (EmailProviderReq)
EmailProviderReq
name
string
Optional
description
string
Optional
api_key
string
Optional
type
string
Optional
provider
string
Optional
from_address
array of object (EmailProviderReqFrom)
Optional
Array of EmailProviderReqFrom
Response
200
404
500
Success
EmailProvider
type
string
Optional
provider
string
Optional
from_address
array of object (EmailProviderReqFrom)
Optional
Array of EmailProviderReqFrom
_id
string
Optional
name
string
Optional
description
string
Optional
api_key
string
Optional
application
string
Optional
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers/{id}
Loading...
Response
Example response not available.
DEL

Delete an email provider

Removes a specific email communication provider from the platform permenantly.
Parameters
id
string
Email provider id
Response
200
400
404
500
Refer `GenericDelete` schema for more details.
GenericDelete
message
string
Optional
acknowledged
boolean
Optional
affected
integer
| int32
Optional
operation
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers/{id}
Loading...
Response
Example response not available.
GET

Get all SMS providers

Retrieves a list of SMS communication providers.
Parameters
pageNo
integer
| value > 1
Optional
Current page no
pageSize
integer
Optional
Current request items count
sort
object
Optional
To sort based on created_at
query
object
Optional
To search based on plain text
Response
200
500
Success
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers
Loading...
Response
Example response not available.
POST

Create SMS provider

Creates a new SMS communication provider.
Parameters
body
object (SmsProviderReq)
SmsProviderReq
name
string
Optional
token
string
Optional
description
string
Optional
sender
string
Optional
username
string
Optional
authkey
string
Optional
type
string
Optional
provider
string
Optional
password
string
Optional
The password for the test.
senderid
string
Optional
The sender ID for the test.
feedid
string
Optional
The feed ID for the test.
entityid
string
Optional
The entity ID for the test.
override_dnd
boolean
Optional
Whether to override Do Not Disturb.
host
string
Optional
The host for the test.
port
integer
Optional
The port for the test.
entity_id
string
Optional
The entity ID for the test.
apikey
string
Optional
The apikey for the test.
version_id
integer
| int32
Optional
The version ID for the test.
sender_id
string
Optional
The sender ID for the test.
api_key
string
Optional
The api_key for the test.
Response
200
500
Success
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers
Loading...
Response
Example response not available.
GET

Get all default SMS providers

Retrieve all the default SMS communication providers.
Parameters
No Parameters
Response
200
500
Successful retrieval of the default SMS providers list
Array of DefaultSmsProviders
_id
string
Optional
name
string
Optional
is_default
boolean
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/default-providers
Loading...
Response
Example response not available.
GET

Get a SMS provider

Retrieve detailed information about a specific SMS communication provider.
Parameters
id
string
Sms provider id
Response
200
404
500
Success
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers/{id}
Loading...
Response
Example response not available.
PUT

Update SMS provider

Modifys the configurations of a specific SMS communication provider.
Parameters
id
string
Sms provider id
body
object (SmsProviderReq)
SmsProviderReq
name
string
Optional
token
string
Optional
description
string
Optional
sender
string
Optional
username
string
Optional
authkey
string
Optional
type
string
Optional
provider
string
Optional
password
string
Optional
The password for the test.
senderid
string
Optional
The sender ID for the test.
feedid
string
Optional
The feed ID for the test.
entityid
string
Optional
The entity ID for the test.
override_dnd
boolean
Optional
Whether to override Do Not Disturb.
host
string
Optional
The host for the test.
port
integer
Optional
The port for the test.
entity_id
string
Optional
The entity ID for the test.
apikey
string
Optional
The apikey for the test.
version_id
integer
| int32
Optional
The version ID for the test.
sender_id
string
Optional
The sender ID for the test.
api_key
string
Optional
The api_key for the test.
Response
200
404
500
Success
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers/{id}
Loading...
Response
Example response not available.
DEL

Delete an SMS provider

Removes a specific SMS communication provider from the platform permenantly.
Parameters
id
string
Sms provider id
Response
200
400
404
500
Refer `GenericDelete` schema for more details.
GenericDelete
message
string
Optional
acknowledged
boolean
Optional
affected
integer
| int32
Optional
operation
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers/{id}
Loading...
Response
Example response not available.

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

Operations
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/log
# Get communication reports
GET

Get communication reports

Retrieve a lsit of logs and records of communication activities.
Parameters
pageId
string
Optional
Current page no
pageSize
integer
Optional
Current request items count
sort
object
Optional
To sort based on _id
Properties
_id
integer
Optional
query
object
Optional
Response
200
Success
Logs
items
array of object (Log)
Optional
Array of Log
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/log
Loading...
Response
Example response not available.

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.

Operations
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates
# Get all SMS templates
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates
# Create a SMS template
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/system-templates
# Gets all system SMS templates
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates/{id}
# Get a SMS template
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates/{id}
# Update a SMS template
DEL
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates/{id}
# Delete an SMS template
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/subscribedTemplates
# Get all subscribed SMS templates
GET

Get all SMS templates

Retrieve a list of all SMS communication templates.
Parameters
pageNo
integer
| value > 1
Optional
Current page no
pageSize
integer
Optional
Current request items count
sort
object
Optional
To sort based on created_at
query
object
Optional
To search based on plain text
Response
200
500
Refer `SmsTemplates` schema for more details.
SmsTemplates
items
array of object (SmsTemplate)
Optional
Array of SmsTemplate
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates
Loading...
Response
Example response not available.
POST

Create a SMS template

Creates a new SMS communication template.
Parameters
body
object (SmsTemplateReq)
SmsTemplateReq
name
string
description
string
Optional
priority
string
Optional
Enum
template_id
string
Optional
meta
object (metaObj)
Optional
metaObj
template_variables
object
Optional
published
boolean
Optional
message
object (SmsTemplateMessage)
Optional
SmsTemplateMessage
Response
200
500
Refer `SmsTemplate` schema for more details.
SmsTemplate
url_shorten
object (EnabledObj)
Optional
EnabledObj
_id
string
Optional
application
string
Optional
is_system
boolean
Optional
is_internal
boolean
Optional
meta
object (metaObj)
Optional
metaObj
name
string
Optional
description
string
Optional
message
object (SmsTemplateMessage)
Optional
SmsTemplateMessage
priority
string
Optional
Enum
tags
array of string
Optional
template_variables
object
Optional
template_id
string
Optional
published
boolean
Optional
category
string
Optional
Enum
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates
Loading...
Response
Example response not available.
GET

Gets all system SMS templates

Retrieves system-defined SMS communication templates.
Parameters
No Parameters
Response
200
500
Refer `SystemSmsTemplates` schema for more details.
Array of SystemSmsTemplates
url_shorten
object (EnabledObj)
Optional
EnabledObj
_id
string
Optional
is_system
boolean
Optional
is_internal
boolean
Optional
name
string
Optional
description
string
Optional
message
object (SmsTemplateMessage)
Optional
SmsTemplateMessage
priority
string
Optional
Enum
tags
array of string
Optional
template_variables
object
Optional
template_id
string
Optional
published
boolean
Optional
category
string
Optional
Enum
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/system-templates
Loading...
Response
Example response not available.
GET

Get a SMS template

Retrieves detailed information about a specific SMS communication template.
Parameters
id
string
Sms template id
Response
200
400
404
500
Refer `SmsTemplate` schema for more details.
SmsTemplate
url_shorten
object (EnabledObj)
Optional
EnabledObj
_id
string
Optional
application
string
Optional
is_system
boolean
Optional
is_internal
boolean
Optional
meta
object (metaObj)
Optional
metaObj
name
string
Optional
description
string
Optional
message
object (SmsTemplateMessage)
Optional
SmsTemplateMessage
priority
string
Optional
Enum
tags
array of string
Optional
template_variables
object
Optional
template_id
string
Optional
published
boolean
Optional
category
string
Optional
Enum
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates/{id}
Loading...
Response
Example response not available.
PUT

Update a SMS template

Modifys the content and settings of a specific SMS communication template.
Parameters
id
string
Sms template id
body
object (SmsTemplateReq)
SmsTemplateReq
name
string
description
string
Optional
priority
string
Optional
Enum
template_id
string
Optional
meta
object (metaObj)
Optional
metaObj
template_variables
object
Optional
published
boolean
Optional
message
object (SmsTemplateMessage)
Optional
SmsTemplateMessage
Response
200
400
404
500
Refer `SmsTemplate` schema for more details.
SmsTemplate
url_shorten
object (EnabledObj)
Optional
EnabledObj
_id
string
Optional
application
string
Optional
is_system
boolean
Optional
is_internal
boolean
Optional
meta
object (metaObj)
Optional
metaObj
name
string
Optional
description
string
Optional
message
object (SmsTemplateMessage)
Optional
SmsTemplateMessage
priority
string
Optional
Enum
tags
array of string
Optional
template_variables
object
Optional
template_id
string
Optional
published
boolean
Optional
category
string
Optional
Enum
created_at
string
Optional
updated_at
string
Optional
slug
string
Optional
__v
integer
| int32
Optional
Examples
Parameters
body:
body
Was this section helpful?
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates/{id}
Loading...
Response
Example response not available.
DEL

Delete an SMS template

Removes a specific SMS communication template from the platform permenantly.
Parameters
id
string
Sms template id
Response
200
400
404
500
Refer `GenericDelete` schema for more details.
GenericDelete
message
string
Optional
acknowledged
boolean
Optional
affected
integer
| int32
Optional
operation
string
Optional
Examples
Parameters
Parameters are not required.
Was this section helpful?
DEL
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates/{id}
Loading...
Response
Example response not available.
GET

Get all subscribed SMS templates

Retrieve a list of SMS communication templates that are subscribed to an event.
Parameters
pageNo
integer
| value > 1
Optional
Current page no
pageSize
integer
Optional
Current request items count
query
object
Optional
To search based on plain text
Response
200
500
Refer `SmsTemplates` schema for more details.
SmsTemplates
items
array of object (SmsTemplate)
Optional
Array of SmsTemplate
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/subscribedTemplates
Loading...
Response
Example response not available.

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.

Operations
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/engine/send-instant
# Send communication synchronously
POST

Send communication synchronously

Sends real-time communications to sellers with immediate delivery.
Parameters
body
object (EngineRequest)
Pass the api payload as shown below.
EngineRequest
payload
object (PayloadStructure)
Optional
PayloadStructure
meta
object (MetaStructure)
Optional
MetaStructure
Response
200
Success
EngineResponse
success
boolean
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/engine/send-instant
Loading...
Response
Example response not available.

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.

Operations
GET
/service/platform/communication/v1.0/company/{company_id}/notification/system-notifications/
# Get system notifications
GET

Get system notifications

Retrieves a list of system notifications.
Parameters
pageNo
integer
| int32
Optional
pageSize
integer
| int32
Optional
Response
200
Success
SystemNotifications
items
array of object (SystemNotification)
Optional
Array of SystemNotification
last_read_anchor
integer
| int32
Optional
page
object (Page)
Optional
Page
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/communication/v1.0/company/{company_id}/notification/system-notifications/
Loading...
Response
Example response not available.