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:

Curl

Get the default channel:

curl -X GET \
     -u '[SID]:[TOKEN]' \
     'https://api.essential.to/v2/account/channels'


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."}'


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.

help@essential.to