Skip to main content
POST
Send Message
Ensure the Sender ID Or Template have been pre-approved for the coverage before attempting to send a message.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
emails
string[]

A copy of this message can be sent to these email addresses. (attarcts extra cost)

Example:
isBulk
boolean

Enable or Disable if this meessage is bulk or not

Example:

false

messageBody
string

Message body with expected number of characters

Example:

"Hey there"

phoneBookId
number

Phonebook ID must be passed if isBulk is set to true

Example:

4

receiverNumber
string

Target phone number for delivery

Example:

"15678909999"

senderId
string

Pre-approved sender id based on the region and route

Example:

"SUPERHUMAN"

sendtoEmail
boolean

If message should be sent to email or not

Example:

true

subject
string

The subject of the email if sendtoEmail is set to true

Example:

"Thanks for Applying"

template
object

This section becomes effective if templateInUse is set to true

templateInUse
boolean

Used if the message should be sent using a template

Example:

true

Response

200 - undefined