Introduction

Use the Easify REST API to send SMS and email, manage contacts and phone numbers, and maintain your blacklist from your own applications.

Base URL

All endpoints use this base URL:

https://api.easify.live

Each endpoint page shows its full path, starting with /api/ and the version. Add it to the base URL to get the full address. For example, /api/v2/sms/send becomes https://api.easify.live/api/v2/sms/send.

API versions

Endpoints are available under v2 and v3. Some actions exist in both versions and behave differently, so pick the one that fits your use case:

• Send SMS (New) (/api/v3/sms/send) allows 10000 requests per minute, compared with 1000 for Send SMS (Classic) (/api/v2/sms/send). Messages are queued and may take up to 1 hour to be sent.
• Send Multi-Recipient Email (/api/v3/email/send) supports multiple recipients, CC and BCC.

Make your first request

1. Copy your API token from the Easify app under Settings > API Settings.
2. Add your server's public IP address to your API whitelist.
3. Send a request. This one lists your phone numbers:

curl https://api.easify.live/api/v2/phone-numbers \
  -H "Authorization: Bearer <>" \
  -H "Accept: application/json"

See Authentication for the full details.

Try it in Postman

Import the Easify API collection into Postman to try every endpoint. Set the api_token collection variable to your token, and replace the sample values before you send a request. The requests are real: they send messages, spend credits and change data.

Download Postman Collection

Error responses

Each endpoint page lists its error cases under Responses.

Validation errors return HTTP 422 with the first error as message and every error grouped by field under errors. These responses have no status key, unlike most other errors. When more than one field fails, message ends with "(and N more errors)".

{
  "message": "The to number field is required. (and 1 more error)",
  "errors": {
    "to_number": ["The to number field is required."],
    "message": ["The message field is required."]
  }
}