Carillon docsAPI reference
Base URL, authentication, response format, and endpoint schemas.
Base URL
https://api.carillon.devUse HTTPS. Request bodies are JSON with Content-Type: application/json, except
device imports, which use text/csv.
Authentication
| Operations | Credential |
|---|---|
| Send, read delivery results, manage and import devices | Secret API key |
| Register a device and report events | Mobile API key |
| Manage organizations, apps, credentials, keys, and audiences | Session token |
Send the credential in the bearer header:
Authorization: Bearer carillon_sk_live_…See authentication for key creation, permissions, and rotation.
Responses
Successful responses return the resource or an empty body for 204.
A send returns 202 with a campaign ID; poll GET /v1/messages/{id} for delivery results.
Errors use Content-Type: application/problem+json. Read the stable code field to handle a
specific failure and detail for context. See API errors.
Responses include rate-limit headers, including on successful requests.
Compatibility
Public API changes are additive. Existing fields and operations remain supported. Clients should accept additional response fields.
Endpoints
The endpoint pages are generated from the committed OpenAPI specification.