Skip to content

Guide
API reference
Self-hosting
Roadmap

Sidebar Navigation

API reference

Audit

GET GET /audit-entries

Auth

GET GET /auth/me
GET GET /auth/tokens
POST POST /auth/tokens
POST POST /auth/tokens/bootstrap
DELETE DELETE /auth/tokens/{id}

Automations

GET GET /automations
POST POST /automations
GET GET /automations/{id}
PUT PUT /automations/{id}
DELETE DELETE /automations/{id}
POST POST /automations/{id}/activate
POST POST /automations/{id}/deactivate

Broadcasts

GET GET /broadcasts
POST POST /broadcasts
GET GET /broadcasts/{id}
PUT PUT /broadcasts/{id}
DELETE DELETE /broadcasts/{id}
PUT PUT /broadcasts/{id}/audience
GET GET /broadcasts/{id}/report
POST POST /broadcasts/{id}/schedule
POST POST /broadcasts/{id}/test-send
POST POST /broadcasts/{id}/unschedule

Contacts

GET GET /contacts
POST POST /contacts
POST POST /contacts/batch
DELETE DELETE /contacts/erase
POST POST /contacts/export
GET GET /contacts/{id}
PUT PUT /contacts/{id}
DELETE DELETE /contacts/{id}

Tags

GET GET /contacts/{contactId}/tags
POST POST /contacts/{contactId}/tags
DELETE DELETE /contacts/{contactId}/tags/{name}
GET GET /tags

Custom fields

GET GET /custom-fields

Emails

POST POST /emails

Events

POST POST /events
GET GET /events/actions
POST POST /events/batch

Integrations

GET GET /integrations
POST POST /integrations
GET GET /integrations/{id}
PUT PUT /integrations/{id}
DELETE DELETE /integrations/{id}

Segments

GET GET /segments
POST POST /segments
POST POST /segments/preview
GET GET /segments/{id}
PUT PUT /segments/{id}
DELETE DELETE /segments/{id}

Sending domains

GET GET /sending-domains
POST POST /sending-domains
GET GET /sending-domains/rates
GET GET /sending-domains/{id}
PUT PUT /sending-domains/{id}
DELETE DELETE /sending-domains/{id}
POST POST /sending-domains/{id}/verify

Consent

POST POST /suppressions
POST POST /unsubscribes

Templates

GET GET /templates
POST POST /templates
GET GET /templates/{id}
PUT PUT /templates/{id}
DELETE DELETE /templates/{id}

Webhooks

GET GET /webhooks
POST POST /webhooks
GET GET /webhooks/{id}
PUT PUT /webhooks/{id}
DELETE DELETE /webhooks/{id}

On this page

API reference

Every operation of the external API (/api, Bearer token), generated from the OpenAPI document that TypeScript and Go clients are built from. Pick an operation in the sidebar. Authentication, scopes, pagination and errors are explained in the API guide.

The raw document is openapi/external.openapi.json in the repository.

Last updated:

Pager

Next page GET GET /audit-entries