API Documentation:

Wondering where to begin with Essential? Here is a gentle guide to help you send messages today.

Entity Relations:

Here is a brief overview of how the various entities in the platform relate:

Quick examples:


Get the default channel:

curl -X GET \
     -u '[SID]:[TOKEN]' \

Subscribers are customers (people) that belong to channels. Create a subscriber on the default channel:

curl -X POST \
     -u '[SID]:[TOKEN]' \
     -H 'Content-Type: application/json' \
     'https://api.essential.to/v2/account/subscribers' \
     -d '{ "phone_number":"15555555555", "channel":"ch_p03Gjl8Uzn0RkZSpHXHnrw" }'

Send a message to the subscriber

curl -X POST \
     -u '[SID]:[TOKEN]' \
     -H 'Content-Type: application/json' \
     'https://api.essential.to/v2/account/messages' \
     -d '{"subscriber":"sub_p03Gjl8Uzn0RkZSpHXHnrw","body":"Hello world."}'


It is important to know your responsibilities when sending messages - make sure you read through the Compliance notes.


If you're having trouble finding what you're looking for, shoot us an email and we'll help you out as soon as we can.