Skip to content

Endpoints

Every route below is under api.<DOMAIN> and requires X-API-Key, except where noted.

Sending

MethodPathNotes
POST/v1/sendSend one message over one or more channels
GET/v1/messagesDelivery history
GET/v1/messages/{id}One message
GET/v1/emails/{id}The rendered email

Contacts

MethodPathNotes
POST GET/v1/contactsCreate / list
GET PATCH DELETE/v1/contacts/{id}One contact
POST DELETE/v1/contacts/{id}/unsubscribeSuppress / lift
GET DELETE/v1/unsubscribes[/{id}]The suppression list
POST GET/v1/contact-importsBulk CSV import
GET/v1/contact-imports/{id}Import status
POST GET PATCH DELETE/v1/contact-properties[/{id}]Property definitions
POST GET PATCH DELETE/v1/contact-tags[/{id}]Tags

Segments

MethodPathNotes
POST GET/v1/segmentsCreate / list
GET PATCH DELETE/v1/segments/{id}One segment
GET/v1/segments/{id}/contactsLive membership

Broadcasts

MethodPathNotes
POST GET/v1/broadcastsCreate / list
GET PATCH DELETE/v1/broadcasts/{id}Edit and delete are draft-only
POST/v1/broadcasts/{id}/sendQueue the fan-out

Templates

MethodPathNotes
POST GET/v1/templatesCreate / list
GET PATCH DELETE/v1/templates/{id}One template
POST/v1/templates/{id}/moveMove between folders
POST GET PATCH DELETE/v1/template-folders[/{id}]Folders

Forms

MethodPathNotes
POST GET/v1/formsCreate / list
GET PATCH DELETE/v1/forms/{id}One form
GET/v1/forms/{id}/submissionsSubmissions — paged (page, per_page)
POST/v1/forms/{id}/submissionsPublic. No API key — rate-limited instead. Form encodings only; 303 to the form's redirect_url when the caller accepts text/html

See the Forms guide for the embed markup, the _gotcha spam trap and the thank-you redirect.

Automations

MethodPathNotes
POST GET/v1/automationsCreate / list
GET PATCH DELETE/v1/automations/{id}One automation
GET/v1/automations/{id}/runsPer-node run detail
GET/v1/automations/{id}/metricsPer-automation counts
GET/v1/automations/metricsAcross all automations

Channels, domains, webhooks

MethodPathNotes
POST GET DELETE/v1/channels[/{id}]Discord / Telegram credentials (stored encrypted)
POST/v1/channels/{id}/messagesPush to a channel
POST GET DELETE/v1/domains[/{id}]Sender domains
POST/v1/domains/{id}/verifyCheck DNS and mark verified
POST GET DELETE/v1/webhooks[/{id}]Signed event callbacks

Account

MethodPathNotes
GET/v1/usagePlan, limits and current usage
GET/healthPublic. Service health

Released under the Apache 2.0 License.