API reference
text
https://api.ace-send.com/v1Every request needs Authorization: Bearer <API key> (Authentication). Bodies are JSON (Content-Type: application/json); errors are application/problem+json (Errors).
Endpoints
| Endpoint | Permission | |
|---|---|---|
| Send a message | POST /v1/messages | send |
| List the messages | GET /v1/messages | status |
| Get a message | GET /v1/messages/{message} | status |
| List the templates | GET /v1/templates | send |
| List the custom fields | GET /v1/fields | contacts |
| Create or update a contact | POST /v1/contacts | contacts |
Webhook events
| Event | When |
|---|---|
message.sent | Message sent |
message.delivered | Message delivered |
message.read | Message read |
message.failed | Message failed |
template.status | Template reviewed |
balance.low | Balance is low |
campaign.finished | Campaign finished |
test.ping | Test event (sent on demand, cannot be chosen) |
OpenAPI
The same reference as an OpenAPI 3.1 document, with examples and the webhooks: openapi.json. Import it into Postman or Insomnia, or generate a client from it.