API reference
Base URL: https://api.jumploon.com
Authenticate every request with Authorization: Bearer <API key>. Request and response bodies are JSON. The Key column shows the scope needed: Send works with send-only keys; Full needs a full-access key.
List endpoints in the REST API return { "object": "list", "has_more": bool, "data": [...] } and accept limit (1–100, default 20) with after or before cursors.
REST API
Emails
| Method | Path | Key | Description |
|---|
POST | /emails | Send | Send an email |
POST | /emails/batch | Send | Send up to 100 emails |
GET | /emails | Full | List sent emails |
GET | /emails/:id | Full | Get an email and its last event |
PATCH | /emails/:id | Send | Reschedule a scheduled email |
POST | /emails/:id/cancel | Send | Cancel a scheduled email |
Receiving
| Method | Path | Key | Description |
|---|
GET | /emails/receiving | Full | List received emails |
GET | /emails/receiving/:id | Full | Get a received email |
GET | /emails/receiving/:id/attachments | Full | Get its attachments |
DELETE | /emails/receiving/:id | Full | Delete it |
Domains
| Method | Path | Key | Description |
|---|
POST | /domains | Full | Add a domain (name) |
GET | /domains | Full | List domains |
GET | /domains/:id | Full | Get a domain and its DNS records |
PATCH | /domains/:id | Full | Set open_tracking, click_tracking |
POST | /domains/:id/verify | Full | Check DNS now |
DELETE | /domains/:id | Full | Remove a domain |
API keys
| Method | Path | Key | Description |
|---|
POST | /api-keys | Full | Create a key (name, permission, domain_id) |
GET | /api-keys | Full | List keys |
PATCH | /api-keys/:id | Full | Rename a key |
DELETE | /api-keys/:id | Full | Revoke a key |
| Method | Path | Key | Description |
|---|
POST | /contacts | Full | Create or update a contact |
GET | /contacts | Full | List contacts |
GET | /contacts/:id-or-email | Full | Get a contact |
PATCH | /contacts/:id-or-email | Full | Update a contact |
DELETE | /contacts/:id-or-email | Full | Delete a contact |
GET | /contacts/:contact/segments | Full | List the contact's segments |
POST | /contacts/:contact/segments/:segment | Full | Add to a segment |
DELETE | /contacts/:contact/segments/:segment | Full | Remove from a segment |
GET | /contacts/:contact/topics | Full | The contact's topic subscriptions |
PATCH | /contacts/:contact/topics | Full | Change subscriptions |
Segments
| Method | Path | Key | Description |
|---|
POST | /segments | Full | Create a segment |
GET | /segments | Full | List segments |
GET | /segments/:id | Full | Get a segment |
PATCH | /segments/:id | Full | Rename a segment |
DELETE | /segments/:id | Full | Delete a segment |
GET | /segments/:id/contacts | Full | List its contacts |
The legacy /audiences routes behave the same as /segments.
| Method | Path | Key | Description |
|---|
POST | /topics | Full | Create a topic |
GET | /topics | Full | List topics |
GET / PATCH / DELETE | /topics/:id | Full | Get, update, delete |
POST | /contact-properties | Full | Create a property |
GET | /contact-properties | Full | List properties |
GET / PATCH / DELETE | /contact-properties/:id | Full | Get, change fallback, delete |
Broadcasts
| Method | Path | Key | Description |
|---|
POST | /broadcasts | Full | Create a broadcast |
GET | /broadcasts | Full | List broadcasts |
GET | /broadcasts/:id | Full | Get a broadcast |
GET | /broadcasts/:id/stats | Full | Delivery and engagement counts |
PATCH | /broadcasts/:id | Full | Update a draft |
DELETE | /broadcasts/:id | Full | Delete a draft |
POST | /broadcasts/:id/send | Full | Send now or at scheduled_at |
POST | /broadcasts/:id/cancel | Full | Cancel a scheduled broadcast |
Automations & events
| Method | Path | Key | Description |
|---|
POST | /automations | Full | Create an automation |
GET | /automations | Full | List automations |
GET / PATCH / DELETE | /automations/:id | Full | Get, update, delete |
GET | /automations/:id/runs | Full | List runs |
POST | /automations/:id/runs/:run/cancel | Full | Cancel a run |
POST | /events | Send | Send an event for a contact |
Webhooks
| Method | Path | Key | Description |
|---|
POST | /webhooks | Full | Create an endpoint (endpoint, events) |
GET | /webhooks | Full | List endpoints |
GET / PATCH / DELETE | /webhooks/:id | Full | Get, update, delete |
POST | /webhooks/:id/signing-secret/rotate | Full | Rotate the signing secret |
GET | /webhooks/:id/events | Full | Recent deliveries |
POST | /webhooks/:id/events/:eventId/replay | Full | Deliver an event again |
POST | /webhooks/:id/test | Full | Send a test event |
v3 API
| Method | Path | Key | Description |
|---|
POST | /v3/mail/send | Send | Send mail |
POST / GET | /v3/templates | Full | Create, list templates |
GET / PATCH / DELETE | /v3/templates/:id | Full | Get, update, delete |
GET | /v3/templates/:id/versions | Full | List versions |
POST | /v3/templates/:id/versions/:version/restore | Full | Restore a version |
GET / POST | /v3/suppressions | Full | List, add suppressions |
DELETE | /v3/suppressions/:type/:email | Full | Remove a suppression |
GET / POST | /v3/api_keys | Full | List, create API keys |
DELETE | /v3/api_keys/:id | Full | Revoke a key |
GET / POST | /v3/domains | Full | List, add domains |
GET / PATCH / DELETE | /v3/domains/:domain | Full | Get, set tracking_host / inbound_host / inbound_forward_to, remove |
POST | /v3/domains/:domain/validate | Full | Check DNS now |
GET | /v3/domains/:domain/health | Full | DNS and delivery health |
GET / PATCH | /v3/user/webhooks/event/settings | Full | Event webhook settings |
GET | /v3/messages | Full | Activity (to, category, limit) |
GET | /v3/messages/:id | Full | One message with its events |
GET | /v3/stats | Full | Daily statistics |
GET | /v3/categories | Full | Categories in use |
GET | /v3/logs | Full | API request logs |
GET / POST | /v3/teammates | Full | List, invite teammates |
PATCH / DELETE | /v3/teammates/:userId | Full | Change role, remove |
GET / POST | /v3/alerts | Full | List, create alerts |
PATCH / DELETE | /v3/alerts/:id | Full | Update, delete |
GET | /v3/alerts/events | Full | When alerts fired |
GET / POST | /v3/subaccounts | Full | List, create subaccounts (create needs a dashboard session) |
PATCH | /v3/subaccounts/:id | Full | Rename, set quota, suspend |