Communication

Manages email, sms, push notifications sent to users

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.

Initiate and send communication with the option for asynchronous processing.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Request body
payload
object (SendSyncReq)
SendSyncReq
data
array of object (SendSyncData)
Array of SendSyncData
phone_number
string
country_code
string
to
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
email
object (PayloadEmailStructure)
PayloadEmailStructure
template
object (PayloadEmailTemplateStructure)
PayloadEmailTemplateStructure
key
string
value
object
oneOf Schema from below
provider
object (PayloadEmailProviderStructure)
PayloadEmailProviderStructure
slug
string
sms
object (PayloadSmsStructure)
PayloadSmsStructure
template
object (PayloadSmsTemplateStructure)
PayloadSmsTemplateStructure
key
string
value
object
oneOf Schema from below
provider
object (PayloadSmsProviderStructure)
PayloadSmsProviderStructure
slug
string
meta
object (MetaStructure)
MetaStructure
job_type
string
action
string
trace
string
timestamp
string
Response
200
Success
EngineRes
success
boolean
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
body:
body
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/engine/send-async
Loading...
Response
Loading...

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/datasources
# Get audiences.
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources
# Create audience.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources/{id}
# Get audience by ID.
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/get-n-records
# Get N sample records from CSV.
GET

Get audiences.

Audience is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
page_no
integer
| value > 1
Current page no
page_size
integer
Current request items count
sort
string
To sort based on created_at
query
string
To search based on plain text
Response
200
Success
Audiences
items
array of object (Audience)
Array of Audience
_id
string
application
string
name
string
description
string
records_count
integer
| int32
type
string
tags
array of string
headers
array of string
file_url
string
is_active
boolean
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
page_no:
1
page_size:
10
sort:
"{"created_at": -1}"
query:
"{"$or":[{"name":{"$regex":"abc","$options":"i"}}]}"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources
Loading...
Response
Loading...
POST

Create audience.

Add audience which is used to import CSV files containing emails, phone numbers, and other variables in order to populate email/SMS templates for bulk delivery via a Campaign.
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Request body
name
string
description
string
tags
array of string
file_url
string
type
string
records_count
integer
| int32
headers
array of string
Response
200
Refer `Audience` schema for more details.
Audience
_id
string
application
string
name
string
description
string
records_count
integer
| int32
type
string
tags
array of string
headers
array of string
file_url
string
is_active
boolean
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
body:
body
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources
Loading...
Response
Loading...
GET

Get audience by ID.

Retrieve detailed information about a specific custom communication audience.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
id
string
Required
Event subscription id
Response
200
Refer `Audience` schema for more details.
Audience
_id
string
application
string
name
string
description
string
records_count
integer
| int32
type
string
tags
array of string
headers
array of string
file_url
string
is_active
boolean
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
id:
"64b2ddb6cb99a609e12a9bea"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/datasources/{id}
Loading...
Response
Loading...
POST

Get N sample records from CSV.

Retrieve a specified number of sample records from a CSV data source.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Request body
url
string
header
boolean
count
integer
| int32
Response
200
Refer `GetNRecordsCsvRes` schema for more details.
GetNRecordsCsvRes
items
array of object (GetNRecordsCsvResItems)
Array of GetNRecordsCsvResItems
phone_number
string
email
string
firstname
string
lastname
string
orderid
string
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
body:
body
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sources/get-n-records
Loading...
Response
Loading...

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
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/trigger-job
# Trigger campaign job.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/jobs
# Get jobs.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/logs
# Get job logs.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns
# Get campaigns.
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns
# Create campaign.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns/{id}
# Get campaign by ID.
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns/{id}
# Update campaign by ID.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/get-stats/{id}
# Get campaign statistics by ID.
POST

Trigger campaign job.

Initiate a job to execute a communication campaign.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Request body
job_id
string
Response
200
Success
TriggerJobRes
status
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
body:
body
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/trigger-job
Loading...
Response
Loading...
GET

Get jobs.

Retrieve a list of communication jobs.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
page_no
integer
| value > 1
Current page no
page_size
integer
Current request items count
sort
string
To sort based on created_at
query
string
To search based on plain text
Response
200
Success
Jobs
items
array of object (Job)
Array of Job
completed
boolean
is_active
boolean
_id
string
campaign
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
__v
integer
| int32
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
page_no:
1
page_size:
10
sort:
"{"created_at": -1}"
query:
"{"$or":[{"name":{"$regex":"abc","$options":"i"}}]}"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/jobs
Loading...
Response
Loading...
GET

Get job logs.

Retrieve logs and details related to communication jobs.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
page_no
integer
| value > 1
Current page no
page_size
integer
Current request items count
sort
string
To sort based on created_at
query
string
To search based on plain text
Response
200
Success
JobLogs
items
array of object (JobLog)
Array of JobLog
imported
object (StatsImported)
StatsImported
count
integer
| int32
processed
object (StatsProcessed)
StatsProcessed
email
object (StatsProcessedEmail)
StatsProcessedEmail
success
integer
| int32
failed
integer
| int32
suppressed
integer
| int32
sms
object (StatsProcessedSms)
StatsProcessedSms
success
integer
| int32
failed
integer
| int32
suppressed
integer
| int32
_id
string
job
string
campaign
string
created_at
string
| date-time
updated_at
string
| date-time
__v
integer
| int32
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
page_no:
1
page_size:
10
sort:
"{"created_at": -1}"
query:
"{"$or":[{"name":{"$regex":"abc","$options":"i"}}]}"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/jobs/logs
Loading...
Response
Loading...
GET

Get campaigns.

Retrieve a list of communication campaigns.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
query
string
To search based on plain text
page_no
integer
| value > 1
Current page no
page_size
integer
Current request items count
sort
string
To sort based on created_at
Response
200
Success
Campaigns
items
array of object (Campaign)
Array of Campaign
recipient_headers
object (RecipientHeaders)
RecipientHeaders
email
string
email
object (CampaignEmail)
CampaignEmail
template
object (CampaignEmailTemplate)
CampaignEmailTemplate
key
string
value
string
provider
object (CampignEmailProvider)
CampignEmailProvider
_id
string
from_name
string
from_email
string
description
string
tags
array of string
is_active
boolean
_id
string
datasource
string
type
string
name
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
query:
"{"$or":[{"name":{"$regex":"abc","$options":"i"}}]}"
page_no:
1
page_size:
10
sort:
"{"created_at": -1}"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns
Loading...
Response
Loading...
POST

Create campaign.

Add a new communication campaign.
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Request body
recipient_headers
object (RecipientHeaders)
RecipientHeaders
email
string
email
object (CampaignEmail)
CampaignEmail
template
object (CampaignEmailTemplate)
CampaignEmailTemplate
key
string
value
string
provider
object (CampignEmailProvider)
CampignEmailProvider
_id
string
from_name
string
from_email
string
datasource
string
description
string
tags
array of string
headers
array of string
is_active
boolean
name
string
file_url
string
type
string
records_count
integer
| int32
application
string
Response
200
Success
Campaign
recipient_headers
object (RecipientHeaders)
RecipientHeaders
email
string
email
object (CampaignEmail)
CampaignEmail
template
object (CampaignEmailTemplate)
CampaignEmailTemplate
key
string
value
string
provider
object (CampignEmailProvider)
CampignEmailProvider
_id
string
from_name
string
from_email
string
description
string
tags
array of string
is_active
boolean
_id
string
datasource
string
type
string
name
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
body:
body
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns
Loading...
Response
Loading...
GET

Get campaign by ID.

Retrieve detailed information about a specific communication campaign.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
id
string
Required
Event subscription id
Response
200
Success
Campaign
recipient_headers
object (RecipientHeaders)
RecipientHeaders
email
string
email
object (CampaignEmail)
CampaignEmail
template
object (CampaignEmailTemplate)
CampaignEmailTemplate
key
string
value
string
provider
object (CampignEmailProvider)
CampignEmailProvider
_id
string
from_name
string
from_email
string
description
string
tags
array of string
is_active
boolean
_id
string
datasource
string
type
string
name
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
id:
"64b2ddb6cb99a609e12a9bea"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns/{id}
Loading...
Response
Loading...
PUT

Update campaign by ID.

Modify the settings of a specific communication campaign.
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
id
string
Required
Event subscription id
Request body
recipient_headers
object (RecipientHeaders)
RecipientHeaders
email
string
email
object (CampaignEmail)
CampaignEmail
template
object (CampaignEmailTemplate)
CampaignEmailTemplate
key
string
value
string
provider
object (CampignEmailProvider)
CampignEmailProvider
_id
string
from_name
string
from_email
string
datasource
string
description
string
tags
array of string
headers
array of string
is_active
boolean
name
string
file_url
string
type
string
records_count
integer
| int32
application
string
Response
200
Success
Campaign
recipient_headers
object (RecipientHeaders)
RecipientHeaders
email
string
email
object (CampaignEmail)
CampaignEmail
template
object (CampaignEmailTemplate)
CampaignEmailTemplate
key
string
value
string
provider
object (CampignEmailProvider)
CampignEmailProvider
_id
string
from_name
string
from_email
string
description
string
tags
array of string
is_active
boolean
_id
string
datasource
string
type
string
name
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
id:
"64b2ddb6cb99a609e12a9bea"
body:
body
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/campaigns/{id}
Loading...
Response
Loading...
GET

Get campaign statistics by ID.

Retrieve statistical data for a specific communication campaign.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
id
string
Required
Event subscription id
Response
200
Success
GetStats
items
array of object (Stats)
Array of Stats
_id
string
imported
object (StatsImported)
StatsImported
count
integer
| int32
processed
object (StatsProcessed)
StatsProcessed
email
object (StatsProcessedEmail)
StatsProcessedEmail
success
integer
| int32
failed
integer
| int32
suppressed
integer
| int32
sms
object (StatsProcessedSms)
StatsProcessedSms
success
integer
| int32
failed
integer
| int32
suppressed
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
id:
"64b2ddb6cb99a609e12a9bea"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/campaigns/get-stats/{id}
Loading...
Response
Loading...

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 email templates.
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates
# Create email template.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates/{id}
# Get email template by ID.
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates/{id}
# Update email template by ID.
DEL
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates/{id}
# Delete email template by ID.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/system-templates
# Get system email templates.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/subscribedTemplates
# Get subscribed email templates.
GET

Get email templates.

Retrieve a list of available email communication templates.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
page_no
integer
| value > 1
Current page no
page_size
integer
Current request items count
sort
string
To sort based on created_at
query
string
To search based on plain text
Response
200
Refer `EmailTemplates` schema for more details.
EmailTemplates
items
array of object (EmailTemplate)
Array of EmailTemplate
application
string
is_system
boolean
is_internal
boolean
name
string
description
string
editor_type
string
editor_meta
string
static_to
array of string
static_cc
array of string
static_bcc
array of string
reply_to
string
tags
array of string
subject
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
keys
object (TemplateKeys)
TemplateKeys
to
string
cc
string
bcc
string
html
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
url_shorten
object (EnabledObj)
EnabledObj
enabled
boolean
priority
string
Enum
template_variables
object
published
boolean
category
string
Enum
_id
string
headers
array of object (EmailTemplateHeaders)
Array of EmailTemplateHeaders
key
string
value
string
attachments
array of integer
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
from_name
string
text
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
page_no:
1
page_size:
10
sort:
"{"created_at": -1}"
query:
"{"$or":[{"name":{"$regex":"abc","$options":"i"}}]}"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates
Loading...
Response
Loading...
POST

Create email template.

Generate and add a new email communication template.
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Request body
name
string
Required
description
string
from_name
string
static_to
array of string
static_cc
array of string
static_bcc
array of string
reply_to
string
priority
string
Enum
tags
array of string
template_variables
object
published
boolean
subject
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
html
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
editor_type
string
editor_meta
string
attachments
array of integer
headers
array of object (EmailTemplateHeaders)
Array of EmailTemplateHeaders
key
string
value
string
keys
object (EmailTemplateKeys)
EmailTemplateKeys
to
string
cc
string
bcc
string
text
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
Response
200
Refer `EmailTemplate` schema for more details.
EmailTemplate
application
string
is_system
boolean
is_internal
boolean
name
string
description
string
editor_type
string
editor_meta
string
static_to
array of string
static_cc
array of string
static_bcc
array of string
reply_to
string
tags
array of string
subject
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
keys
object (TemplateKeys)
TemplateKeys
to
string
cc
string
bcc
string
html
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
url_shorten
object (EnabledObj)
EnabledObj
enabled
boolean
priority
string
Enum
template_variables
object
published
boolean
category
string
Enum
_id
string
headers
array of object (EmailTemplateHeaders)
Array of EmailTemplateHeaders
key
string
value
string
attachments
array of integer
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
from_name
string
text
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
body:
body
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates
Loading...
Response
Loading...
GET

Get email template by ID.

Retrieve detailed information about a specific email communication template.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
id
string
Required
Event subscription id
Response
200
Refer `EmailTemplate` schema for more details.
EmailTemplate
application
string
is_system
boolean
is_internal
boolean
name
string
description
string
editor_type
string
editor_meta
string
static_to
array of string
static_cc
array of string
static_bcc
array of string
reply_to
string
tags
array of string
subject
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
keys
object (TemplateKeys)
TemplateKeys
to
string
cc
string
bcc
string
html
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
url_shorten
object (EnabledObj)
EnabledObj
enabled
boolean
priority
string
Enum
template_variables
object
published
boolean
category
string
Enum
_id
string
headers
array of object (EmailTemplateHeaders)
Array of EmailTemplateHeaders
key
string
value
string
attachments
array of integer
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
from_name
string
text
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
id:
"64b2ddb6cb99a609e12a9bea"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates/{id}
Loading...
Response
Loading...
PUT

Update email template by ID.

Modify the content and settings of a specific email communication template.
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
id
string
Required
Event subscription id
Request body
name
string
Required
description
string
from_name
string
static_to
array of string
static_cc
array of string
static_bcc
array of string
reply_to
string
priority
string
Enum
tags
array of string
template_variables
object
published
boolean
subject
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
html
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
editor_type
string
editor_meta
string
attachments
array of integer
headers
array of object (EmailTemplateHeaders)
Array of EmailTemplateHeaders
key
string
value
string
keys
object (EmailTemplateKeys)
EmailTemplateKeys
to
string
cc
string
bcc
string
text
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
Response
200
Refer `EmailTemplate` schema for more details.
EmailTemplate
application
string
is_system
boolean
is_internal
boolean
name
string
description
string
editor_type
string
editor_meta
string
static_to
array of string
static_cc
array of string
static_bcc
array of string
reply_to
string
tags
array of string
subject
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
keys
object (TemplateKeys)
TemplateKeys
to
string
cc
string
bcc
string
html
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
url_shorten
object (EnabledObj)
EnabledObj
enabled
boolean
priority
string
Enum
template_variables
object
published
boolean
category
string
Enum
_id
string
headers
array of object (EmailTemplateHeaders)
Array of EmailTemplateHeaders
key
string
value
string
attachments
array of integer
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
from_name
string
text
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
id:
"64b2ddb6cb99a609e12a9bea"
body:
body
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates/{id}
Loading...
Response
Loading...
DEL

Delete email template by ID.

Email templates are predefined formats linked to various events for delivering messages to users. Remove a specific email communication template by its ID.
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
id
string
Required
Event subscription id
Response
200
Refer `GenericDelete` schema for more details.
BasicDelete
acknowledged
boolean
deleted_count
integer
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
id:
"64b2ddb6cb99a609e12a9bea"
DEL
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/templates/{id}
Loading...
Response
Loading...
GET

Get system email templates.

Retrieve system-defined email communication templates.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Response
200
Refer `SystemEmailTemplates` schema for more details.
Array of SystemEmailTemplate
is_system
boolean
is_internal
boolean
name
string
description
string
static_to
array of string
static_cc
array of string
static_bcc
array of string
tags
array of string
subject
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
html
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
url_shorten
object (EnabledObj)
EnabledObj
enabled
boolean
priority
string
Enum
template_variables
object
published
boolean
category
string
Enum
_id
string
headers
array of object (EmailTemplateHeaders)
Array of EmailTemplateHeaders
key
string
value
string
attachments
array of integer
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
text
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/system-templates
Loading...
Response
Loading...
GET

Get subscribed email templates.

Retrieve email communication templates that are subscribed to.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
page_no
integer
| value > 1
Current page no
page_size
integer
Current request items count
query
string
To search based on plain text
Response
200
Refer `EmailTemplates` schema for more details.
SubscribedEmailTemplates
items
array of object (EmailTemplate)
Array of EmailTemplate
application
string
is_system
boolean
is_internal
boolean
name
string
description
string
editor_type
string
editor_meta
string
static_to
array of string
static_cc
array of string
static_bcc
array of string
reply_to
string
tags
array of string
subject
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
keys
object (TemplateKeys)
TemplateKeys
to
string
cc
string
bcc
string
html
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
url_shorten
object (EnabledObj)
EnabledObj
enabled
boolean
priority
string
Enum
template_variables
object
published
boolean
category
string
Enum
_id
string
headers
array of object (EmailTemplateHeaders)
Array of EmailTemplateHeaders
key
string
value
string
attachments
array of integer
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
from_name
string
text
object (TemplateAndType)
TemplateAndType
template_type
string
Enum
template
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
page_no:
1
page_size:
10
query:
"{"$or":[{"name":{"$regex":"abc","$options":"i"}}]}"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/subscribedTemplates
Loading...
Response
Loading...

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 event subscriptions.
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions/bulkUpdate
# Create event subscriptions by bulk
GET

Get event subscriptions.

Retrieve a list of event subscriptions related to communication.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
page_no
integer
| value > 1
Current page no
page_size
integer
Current request items count
populate
string
Populate Fields
Response
200
Success
EventSubscriptions
items
array of object (EventSubscriptionObj)
Array of EventSubscriptionObj
template
object (EventSubscriptionTemplateObj)
EventSubscriptionTemplateObj
sms
object (EventSubscriptionTemplateSmsObj)
EventSubscriptionTemplateSmsObj
subscribed
boolean
template
object
Nullable
email
object (EventSubscriptionTemplateEmailObj)
EventSubscriptionTemplateEmailObj
subscribed
boolean
template
string
Nullable
pushnotification
object (EventSubscriptionTemplatePushnotification)
EventSubscriptionTemplatePushnotification
subscribed
boolean
is_default
boolean
_id
string
application
string
category
string
event
Undefined Type
Nullable
oneOf Schema from below
slug
string
created_at
string
| date-time
updated_at
string
| date-time
__v
integer
| int32
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
page_no:
1
page_size:
10
populate:
"template.sms.template"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions
Loading...
Response
Loading...
POST

Create event subscriptions by bulk

Create event subscriptions by bulk
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Request body
subscriptions
array of object (SubscriptionsObject)
Array of SubscriptionsObject
_id
string
Subscription ID
event
string
slug
string
template
object (TemplateObject)
TemplateObject
sms
object (CommunicationTemplate)
CommunicationTemplate
subscribed
boolean
Whether the user is subscribed or not
template
string
Template ID
email
object (CommunicationTemplate)
CommunicationTemplate
subscribed
boolean
Whether the user is subscribed or not
template
string
Template ID
pushnotification
object (CommunicationTemplate)
CommunicationTemplate
subscribed
boolean
Whether the user is subscribed or not
template
string
Template ID
Response
200
Success
Array of EventSubscriptionsBulkUpdateRes
template
object (EventSubscriptionTemplate)
EventSubscriptionTemplate
sms
object (EventSubscriptionTemplateSms)
EventSubscriptionTemplateSms
subscribed
boolean
template
string
Nullable
email
object (EventSubscriptionTemplateEmail)
EventSubscriptionTemplateEmail
subscribed
boolean
template
string
Nullable
pushnotification
object (EventSubscriptionTemplatePushnotification)
EventSubscriptionTemplatePushnotification
subscribed
boolean
_id
string
application
string
event
string
slug
string
category
string
Enum
created_at
string
| date-time
updated_at
string
| date-time
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
body:
body
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/event/event-subscriptions/bulkUpdate
Loading...
Response
Loading...

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 global variables.
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/global-variables
# Post global variables.
GET

Get global variables.

Retrieve global variables used in communication.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Response
200
Refer `GlobalVariablesGetRes` schema for more details.
GlobalVariablesGetRes
read_only
object
editable
object
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/global-variables
Loading...
Response
Loading...
POST

Post global variables.

Update and post global variables for communication.
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Request body
global_variables
object
Response
200
Refer `GlobalVariablesPostRes` schema for more details.
GlobalVariablesPostRes
_id
string
category
string
Enum
application
string
global_variables
object
created_at
string
| date-time
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
body:
body
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/global-variables
Loading...
Response
Loading...

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 otp-configuration, if not present in db then return default settings
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/otp/otp-configuration
# Update/insert otp configurations
POST

Send OTP.

Send a one-time password (OTP) for authentication or verification.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
ci
boolean
Common Information
Request body
data
object (SendOtpCommsReqData)
SendOtpCommsReqData
send_same_otp_to_channel
boolean
mobile
string
country_code
string
to
string
sms
object (SendOtpCommsReqSms)
SendOtpCommsReqSms
otp_length
integer
| int32
expiry
integer
| int32
template
object
provider
object (SendOtpSmsCommsProvider)
SendOtpSmsCommsProvider
slug
string
_id
string
email
object (SendOtpCommsReqEmail)
SendOtpCommsReqEmail
otp_length
integer
| int32
expiry
integer
| int32
template
object (SendOtpEmailCommsTemplate)
SendOtpEmailCommsTemplate
key
string
value
object
provider
object (SendOtpEmailCommsProvider)
SendOtpEmailCommsProvider
slug
string
_id
string
Response
200
Success
SendOtpCommsRes
sms
object (SendOtpCommsResSms)
SendOtpCommsResSms
success
boolean
request_id
string
message
string
mobile
string
country_code
string
resend_timer
integer
| int32
email
object (SendOtpCommsResEmail)
SendOtpCommsResEmail
success
boolean
request_id
string
message
string
to
string
resend_timer
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
body:
body
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/otp/send-otp-comms
Loading...
Response
Loading...
POST

Verify OTP.

Verify the one-time password (OTP) for authentication or verification.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Request body
request_id
string
otp
string
Response
200
Success
VerifyOtpCommsSuccessRes
success
boolean
mobile
string
country_code
string
message
string
email
string
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
body:
body
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/otp/verify-otp-comms
Loading...
Response
Loading...
GET

Get otp-configuration, if not present in db then return default settings

Get otp-configuration
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Response
200
Success
OtpConfiguration
otp_length
integer
Enum
type
string
Enum
expiry
object (OtpConfigurationExpiry)
OtpConfigurationExpiry
duration
object (OtpConfigurationExpiryDuration)
OtpConfigurationExpiryDuration
time
number
denomination
string
Enum
type
string
Enum
rate_limit
object (OtpConfigRateLimit)
OtpConfigRateLimit
duration
number
| value >= 60
| value <= 3600
limit
number
| value >= 1
| value <= 5
application_id
string
company_id
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/otp/otp-configuration
Loading...
Response
Loading...
PUT

Update/insert otp configurations

Update otp-configuration
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Request body
otp_length
integer
Required
Enum
type
string
Required
Enum
expiry
object (OtpConfigurationExpiry)
Required
OtpConfigurationExpiry
duration
object (OtpConfigurationExpiryDuration)
Required
OtpConfigurationExpiryDuration
time
number
Required
denomination
string
Required
Enum
type
string
Required
Enum
rate_limit
object (OtpConfigRateLimit)
Required
OtpConfigRateLimit
duration
number
| value >= 60
| value <= 3600
limit
number
| value >= 1
| value <= 5
application_id
string
company_id
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Response
200
Success
OtpConfiguration
otp_length
integer
Enum
type
string
Enum
expiry
object (OtpConfigurationExpiry)
OtpConfigurationExpiry
duration
object (OtpConfigurationExpiryDuration)
OtpConfigurationExpiryDuration
time
number
denomination
string
Enum
type
string
Enum
rate_limit
object (OtpConfigRateLimit)
OtpConfigRateLimit
duration
number
| value >= 60
| value <= 3600
limit
number
| value >= 1
| value <= 5
application_id
string
company_id
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
body:
body
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/otp/otp-configuration
Loading...
Response
Loading...

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}/email/providers
# Get email providers.
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers
# Create email provider.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers/{id}
# Get email provider by ID.
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers/{id}
# Update email provider by ID.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/default-providers
# Get app providers.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers
# Get 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/providers/{id}
# Get SMS provider by ID.
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers/{id}
# Update SMS provider by ID.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/default-providers
# Get default SMS 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/get-provider
# Get application providers.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/app-provider/global-providers
# Get global providers.
GET

Get email providers.

Retrieve a list of email communication providers.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
page_no
integer
| value > 1
Current page no
page_size
integer
Current request items count
sort
string
To sort based on created_at
query
string
To search based on plain text
Response
200
Success
EmailProviders
items
array of object (EmailProvider)
Array of EmailProvider
type
string
provider
string
from_address
array of object (EmailProviderReqFrom)
Array of EmailProviderReqFrom
name
string
email
string
is_default
boolean
_id
string
name
string
description
string
api_key
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
page_no:
1
page_size:
10
sort:
"{"created_at": -1}"
query:
"{"$or":[{"name":{"$regex":"abc","$options":"i"}}]}"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers
Loading...
Response
Loading...
POST

Create email provider.

Generate and add a new email communication provider.
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Request body
name
string
description
string
api_key
string
type
string
provider
string
from_address
array of object (EmailProviderReqFrom)
Array of EmailProviderReqFrom
name
string
email
string
is_default
boolean
Response
200
Success
EmailProvider
type
string
provider
string
from_address
array of object (EmailProviderReqFrom)
Array of EmailProviderReqFrom
name
string
email
string
is_default
boolean
_id
string
name
string
description
string
api_key
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
body:
body
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers
Loading...
Response
Loading...
GET

Get email provider by ID.

Retrieve detailed information about a specific email communication provider.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
id
string
Required
Event subscription id
Response
200
Success
EmailProvider
type
string
provider
string
from_address
array of object (EmailProviderReqFrom)
Array of EmailProviderReqFrom
name
string
email
string
is_default
boolean
_id
string
name
string
description
string
api_key
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
id:
"64b2ddb6cb99a609e12a9bea"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers/{id}
Loading...
Response
Loading...
PUT

Update email provider by ID.

Modify the settings of a specific email communication provider.
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
id
string
Required
Event subscription id
Request body
name
string
description
string
api_key
string
type
string
provider
string
from_address
array of object (EmailProviderReqFrom)
Array of EmailProviderReqFrom
name
string
email
string
is_default
boolean
Response
200
Success
EmailProvider
type
string
provider
string
from_address
array of object (EmailProviderReqFrom)
Array of EmailProviderReqFrom
name
string
email
string
is_default
boolean
_id
string
name
string
description
string
api_key
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
id:
"64b2ddb6cb99a609e12a9bea"
body:
body
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/providers/{id}
Loading...
Response
Loading...
GET

Get app providers.

Retrieve a list of app providers.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Response
200
Success
Array of DefaultEmailProviders
_id
string
from_address
array of object (DefaultEmailProvidersFromAddresses)
Array of DefaultEmailProvidersFromAddresses
name
string
email
string
is_default
boolean
name
string
is_default
boolean
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/email/default-providers
Loading...
Response
Loading...
GET

Get SMS providers.

Retrieve a list of SMS communication providers.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
page_no
integer
| value > 1
Current page no
page_size
integer
Current request items count
sort
string
To sort based on created_at
query
string
To search based on plain text
Response
200
Success
SmsProviders
items
array of object (SmsProvider)
Array of SmsProvider
rpt
integer
| int32
type
string
provider
string
_id
string
name
string
description
string
sender
string
username
string
authkey
string
entity_id
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
page_no:
1
page_size:
10
sort:
"{"created_at": -1}"
query:
"{"$or":[{"name":{"$regex":"abc","$options":"i"}}]}"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers
Loading...
Response
Loading...
POST

Create SMS provider.

Add a new SMS communication provider.
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Request body
name
string
description
string
sender
string
username
string
authkey
string
type
string
provider
string
password
string
The password for the test.
senderid
string
The sender ID for the test.
feedid
string
The feed ID for the test.
entityid
string
The entity ID for the test.
override_dnd
boolean
Whether to override Do Not Disturb.
host
string
The host for the test.
port
integer
The port for the test.
entity_id
string
The entity ID for the test.
apikey
string
The apikey for the test.
version_id
integer
| int32
The version ID for the test.
sender_id
string
The sender ID for the test.
api_key
string
The api_key for the test.
Response
200
Success
SmsProvider
rpt
integer
| int32
type
string
provider
string
_id
string
name
string
description
string
sender
string
username
string
authkey
string
entity_id
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
body:
body
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers
Loading...
Response
Loading...
GET

Get SMS provider by ID.

Retrieve detailed information about a specific SMS communication provider.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
id
string
Required
Event subscription id
Response
200
Success
SmsProvider
rpt
integer
| int32
type
string
provider
string
_id
string
name
string
description
string
sender
string
username
string
authkey
string
entity_id
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
id:
"64b2ddb6cb99a609e12a9bea"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers/{id}
Loading...
Response
Loading...
PUT

Update SMS provider by ID.

Modify specific SMS communication provider.
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
id
string
Required
Event subscription id
Request body
name
string
description
string
sender
string
username
string
authkey
string
type
string
provider
string
password
string
The password for the test.
senderid
string
The sender ID for the test.
feedid
string
The feed ID for the test.
entityid
string
The entity ID for the test.
override_dnd
boolean
Whether to override Do Not Disturb.
host
string
The host for the test.
port
integer
The port for the test.
entity_id
string
The entity ID for the test.
apikey
string
The apikey for the test.
version_id
integer
| int32
The version ID for the test.
sender_id
string
The sender ID for the test.
api_key
string
The api_key for the test.
Response
200
Success
SmsProvider
rpt
integer
| int32
type
string
provider
string
_id
string
name
string
description
string
sender
string
username
string
authkey
string
entity_id
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
id:
"64b2ddb6cb99a609e12a9bea"
body:
body
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/providers/{id}
Loading...
Response
Loading...
GET

Get default SMS providers.

Retrieve the default SMS communication providers.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Response
200
Successful retrieval of the default SMS providers list
Array of DefaultSmsProviders
_id
string
name
string
is_default
boolean
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/default-providers
Loading...
Response
Loading...
POST

Update application providers.

Modify provider information for the platform.
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Request body
email
object (AppProviderRes)
AppProviderRes
transaction
object (AppProviderResObj)
AppProviderResObj
provider
string
promotional
object (AppProviderResObj)
AppProviderResObj
provider
string
otp
object (AppProviderResObj)
AppProviderResObj
provider
string
sms
object (AppProviderRes)
AppProviderRes
transaction
object (AppProviderResObj)
AppProviderResObj
provider
string
promotional
object (AppProviderResObj)
AppProviderResObj
provider
string
otp
object (AppProviderResObj)
AppProviderResObj
provider
string
voice
object (AppProviderResVoice)
AppProviderResVoice
transaction
object (AppProviderResObj)
AppProviderResObj
provider
string
otp
object (AppProviderResObj)
AppProviderResObj
provider
string
Response
200
Success
AppProvider
email
object (AppProviderRes)
AppProviderRes
transaction
object (AppProviderResObj)
AppProviderResObj
provider
string
promotional
object (AppProviderResObj)
AppProviderResObj
provider
string
otp
object (AppProviderResObj)
AppProviderResObj
provider
string
sms
object (AppProviderRes)
AppProviderRes
transaction
object (AppProviderResObj)
AppProviderResObj
provider
string
promotional
object (AppProviderResObj)
AppProviderResObj
provider
string
otp
object (AppProviderResObj)
AppProviderResObj
provider
string
voice
object (AppProviderResVoice)
AppProviderResVoice
transaction
object (AppProviderResObj)
AppProviderResObj
provider
string
otp
object (AppProviderResObj)
AppProviderResObj
provider
string
_id
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
body:
body
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/app-provider/update-provider
Loading...
Response
Loading...
GET

Get application providers.

Retrieve a list of providers associated with the platform.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Response
200
Success
AppProvider
email
object (AppProviderRes)
AppProviderRes
transaction
object (AppProviderResObj)
AppProviderResObj
provider
string
promotional
object (AppProviderResObj)
AppProviderResObj
provider
string
otp
object (AppProviderResObj)
AppProviderResObj
provider
string
sms
object (AppProviderRes)
AppProviderRes
transaction
object (AppProviderResObj)
AppProviderResObj
provider
string
promotional
object (AppProviderResObj)
AppProviderResObj
provider
string
otp
object (AppProviderResObj)
AppProviderResObj
provider
string
voice
object (AppProviderResVoice)
AppProviderResVoice
transaction
object (AppProviderResObj)
AppProviderResObj
provider
string
otp
object (AppProviderResObj)
AppProviderResObj
provider
string
_id
string
application
string
created_at
string
| date-time
updated_at
string
| date-time
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/app-provider/get-provider
Loading...
Response
Loading...
GET

Get global providers.

Retrieve a list of global communication providers.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Response
200
Success
GlobalProviders
email
array of object (GlobalProvidersResObj)
Array of GlobalProvidersResObj
_id
string
name
string
sms
array of object (GlobalProvidersResObj)
Array of GlobalProvidersResObj
_id
string
name
string
voice
array of object (GlobalProvidersResObj)
Array of GlobalProvidersResObj
_id
string
name
string
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/app-provider/global-providers
Loading...
Response
Loading...

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 logs.
GET

Get communication logs.

Retrieve logs and records of communication activities.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
page_no
integer
| value > 1
Current page no
page_size
integer
Current request items count
sort
string
To sort based on created_at
query
object
Response
200
Success
Logs
items
array of object (Log)
Array of Log
email
object (LogEmail)
LogEmail
template
string
provider
string
to
string
sms
object (LogSms)
LogSms
template
string
provider
string
phone_number
string
country_code
string
pushnotification
object (LogPushnotification)
LogPushnotification
pushtokens
array of string
_id
string
pod
string
service
string
step
string
source
string
status
string
expire_at
string
| date-time
created_at
string
| date-time
meta
object (LogMeta)
LogMeta
identifier
string
type
string
job
string
campaign
string
key
string
offset
string
partition
string
topic
string
application
string
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
page_no:
1
page_size:
10
sort:
"{"created_at": -1}"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/log
Loading...
Response
Loading...

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 SMS templates.
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates
# Create SMS template.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates/{id}
# Get SMS template by ID.
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates/{id}
# Update SMS template by ID.
DEL
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates/{id}
# Delete SMS template by ID.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/system-templates
# Get system SMS templates.
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/subscribedTemplates
# Get subscribed SMS templates.
GET

Get SMS templates.

Retrieve a list of available SMS communication templates.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
page_no
integer
| value > 1
Current page no
page_size
integer
Current request items count
sort
string
To sort based on created_at
query
string
To search based on plain text
Response
200
Refer `SmsTemplates` schema for more details.
SmsTemplates
items
array of object (SmsTemplate)
Array of SmsTemplate
url_shorten
object (EnabledObj)
EnabledObj
enabled
boolean
_id
string
application
string
is_system
boolean
is_internal
boolean
meta
object (metaObj)
metaObj
type
string
is_system
boolean
template
string
name
string
description
string
message
object (SmsTemplateMessage)
SmsTemplateMessage
template_type
string
template
string
priority
string
Enum
tags
array of string
template_variables
object
template_id
string
published
boolean
category
string
Enum
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
page_no:
1
page_size:
10
sort:
"{"created_at": -1}"
query:
"{"$or":[{"name":{"$regex":"abc","$options":"i"}}]}"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates
Loading...
Response
Loading...
POST

Create SMS template.

Add a new SMS communication template.
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Request body
name
string
Required
description
string
priority
string
Enum
template_id
string
meta
object (metaObj)
metaObj
type
string
is_system
boolean
template
string
template_variables
object
published
boolean
message
object (SmsTemplateMessage)
SmsTemplateMessage
template_type
string
template
string
Response
200
Refer `SmsTemplate` schema for more details.
SmsTemplate
url_shorten
object (EnabledObj)
EnabledObj
enabled
boolean
_id
string
application
string
is_system
boolean
is_internal
boolean
meta
object (metaObj)
metaObj
type
string
is_system
boolean
template
string
name
string
description
string
message
object (SmsTemplateMessage)
SmsTemplateMessage
template_type
string
template
string
priority
string
Enum
tags
array of string
template_variables
object
template_id
string
published
boolean
category
string
Enum
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
body:
body
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates
Loading...
Response
Loading...
GET

Get SMS template by ID.

Retrieve detailed information about a specific SMS communication template.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
id
string
Required
Event subscription id
Response
200
Refer `SmsTemplate` schema for more details.
SmsTemplate
url_shorten
object (EnabledObj)
EnabledObj
enabled
boolean
_id
string
application
string
is_system
boolean
is_internal
boolean
meta
object (metaObj)
metaObj
type
string
is_system
boolean
template
string
name
string
description
string
message
object (SmsTemplateMessage)
SmsTemplateMessage
template_type
string
template
string
priority
string
Enum
tags
array of string
template_variables
object
template_id
string
published
boolean
category
string
Enum
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
id:
"64b2ddb6cb99a609e12a9bea"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates/{id}
Loading...
Response
Loading...
PUT

Update SMS template by ID.

Modify the content and settings of a specific SMS communication template.
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
id
string
Required
Event subscription id
Request body
name
string
Required
description
string
priority
string
Enum
template_id
string
meta
object (metaObj)
metaObj
type
string
is_system
boolean
template
string
template_variables
object
published
boolean
message
object (SmsTemplateMessage)
SmsTemplateMessage
template_type
string
template
string
Response
200
Refer `SmsTemplate` schema for more details.
SmsTemplate
url_shorten
object (EnabledObj)
EnabledObj
enabled
boolean
_id
string
application
string
is_system
boolean
is_internal
boolean
meta
object (metaObj)
metaObj
type
string
is_system
boolean
template
string
name
string
description
string
message
object (SmsTemplateMessage)
SmsTemplateMessage
template_type
string
template
string
priority
string
Enum
tags
array of string
template_variables
object
template_id
string
published
boolean
category
string
Enum
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
id:
"64b2ddb6cb99a609e12a9bea"
body:
body
PUT
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates/{id}
Loading...
Response
Loading...
DEL

Delete SMS template by ID.

Remove a specific SMS communication template.
Requires application/communications/write access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
id
string
Required
Event subscription id
Response
200
Refer `BasicDelete` schema for more details.
BasicDelete
acknowledged
boolean
deleted_count
integer
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
id:
"64b2ddb6cb99a609e12a9bea"
DEL
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/templates/{id}
Loading...
Response
Loading...
GET

Get system SMS templates.

Retrieve system-defined SMS communication templates.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Response
200
Refer `SystemSmsTemplates` schema for more details.
Array of SystemSmsTemplates
url_shorten
object (EnabledObj)
EnabledObj
enabled
boolean
_id
string
is_system
boolean
is_internal
boolean
name
string
description
string
message
object (SmsTemplateMessage)
SmsTemplateMessage
template_type
string
template
string
priority
string
Enum
tags
array of string
template_variables
object
template_id
string
published
boolean
category
string
Enum
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/system-templates
Loading...
Response
Loading...
GET

Get subscribed SMS templates.

Retrieve SMS communication templates that are subscribed to.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
page_no
integer
| value > 1
Current page no
page_size
integer
Current request items count
query
string
To search based on plain text
Response
200
Refer `SmsTemplates` schema for more details.
SubscribedSmsTemplates
items
array of object (SmsTemplates)
Array of SmsTemplates
items
array of object (SmsTemplate)
Array of SmsTemplate
url_shorten
object (EnabledObj)
EnabledObj
enabled
boolean
_id
string
application
string
is_system
boolean
is_internal
boolean
meta
object (metaObj)
metaObj
type
string
is_system
boolean
template
string
name
string
description
string
message
object (SmsTemplateMessage)
SmsTemplateMessage
template_type
string
template
string
priority
string
Enum
tags
array of string
template_variables
object
template_id
string
published
boolean
category
string
Enum
created_at
string
| date-time
updated_at
string
| date-time
slug
string
__v
integer
| int32
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
page_no:
1
page_size:
10
query:
"{"$or":[{"name":{"$regex":"abc","$options":"i"}}]}"
GET
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/sms/subscribedTemplates
Loading...
Response
Loading...

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.

Initiate and send communication in real-time.
Requires application/communications/read access scope.
Parameters
company_id
string
Required
Company id
application_id
string
Required
Application id
Request body
payload
object (SendSyncReq)
SendSyncReq
data
array of object (SendSyncData)
Array of SendSyncData
phone_number
string
country_code
string
to
string
additionalProperties
Allows you to attach properties in addition to the ones mentioned above. Any additional properties are allowed.
email
object (PayloadEmailStructure)
PayloadEmailStructure
template
object (PayloadEmailTemplateStructure)
PayloadEmailTemplateStructure
key
string
value
object
oneOf Schema from below
provider
object (PayloadEmailProviderStructure)
PayloadEmailProviderStructure
slug
string
sms
object (PayloadSmsStructure)
PayloadSmsStructure
template
object (PayloadSmsTemplateStructure)
PayloadSmsTemplateStructure
key
string
value
object
oneOf Schema from below
provider
object (PayloadSmsProviderStructure)
PayloadSmsProviderStructure
slug
string
meta
object (MetaStructure)
MetaStructure
job_type
string
action
string
trace
string
timestamp
string
Response
200
Success
SendInstantRes
success
boolean
provider
string
Nullable
response
boolean
Nullable
Examples
Parameters
company_id:
"2"
application_id:
"64b2ddb6cb99a609e12a9bea"
body:
body
POST
/service/platform/communication/v1.0/company/{company_id}/application/{application_id}/engine/send-instant
Loading...
Response
Loading...