Introduction

This page will help you get started with this SMS Portal.

This reference document is your key to a comprehensive understanding of the use of API's to manage certain aspects of this SMS service.

Integrations can connect to your application to the sms service and build interactive experiences for users within your application. Using the navigation on the left, you'll find details for objects and endpoints used in the API.

📘

Access Token

On the portal, navigate to the Service that you would like to use. Click on the Generate API Key button to generate a new Access Token.

You need an Access Token to interact with this API. You can find your Access Token on the Service Settings page of the SMS service. Click on the Generate API Key button to generate a new Access Token.

If you can't access the token, confirm that you are an admin user of the portal.

📘

API URL

To make an API call, you will need to use your custom API URL to make a call. You can find your custom API URL on the Service Settings page of the SMS Service.

If you can't access the token, confirm that you are an admin user of the portal.

Conventions

The base URL to send all API requests can be found in your Account Settings page (once you are logged in, click on your Avatar on the top right of the page) called API URL. HTTPS is required for all API requests.

The API follows RESTful conventions when possible, with most operations performed via GET, POST, PATCH, and DELETE requests on page and database resources. Request and response bodies are encoded as JSON.