API reference

Every public endpoint, grouped by resource. All paths are relative to https://api.inbuzzed.com/api/v1/esp and authenticated with your API key.

Conventions

Authentication: X-Api-Key: ib_live_... (or Authorization: Bearer) — see Getting started.
Responses: { "status": "success", "data": … }; errors carry status + message.
Each endpoint requires the permission scope shown beside it; plan-gated features additionally return 403 when your plan lacks them.

Transactional

POST/transactional/send

Send a one-to-one message (direct body or template). transactional

GET/transactional/log

Page through the send log. transactional

POST/transactional/log/export

Start an asynchronous log export. transactional

ESP templates

Low-level template records on the sending engine. Most teams design in the dashboard studio instead — see Templates & variables.

GET/transactional/templates

List template records. transactional

POST/transactional/templates

Create a template record. transactional

GET/transactional/templates/:id

Fetch one template. transactional

PATCH/transactional/templates/:id

Update a template. transactional

DELETE/transactional/templates/:id

Delete a template. transactional

POST/transactional/templates/:id/duplicate

Duplicate a template. transactional

POST/transactional/templates/:id/test

Send a test render of the template. transactional

Lists & contacts

GET/lists

List all contact lists. contacts

POST/lists

Create a list. contacts

GET/lists/:id

Fetch one list. contacts

PATCH/lists/:id

Update a list. contacts

DELETE/lists/:id

Delete a list. contacts

GET/lists/:id/feed

Read the list's contacts (cursor via ?older=). contacts

POST/lists/:listId/feed

Add a contact (counts toward your plan's contact limit). contacts

POST/lists/:id/export

Start a list export. contacts

GET/lists/:id/domainstats

Per-domain stats for the list. analytics

Broadcasts

Plan-gated: requires broadcasts on your plan.

GET/broadcasts

List broadcasts (?search=, ?older=). broadcasts

POST/broadcasts

Create a draft. broadcasts

GET/broadcasts/:id

Fetch one broadcast. broadcasts

PATCH/broadcasts/:id

Update a draft. broadcasts

DELETE/broadcasts/:id

Delete a broadcast. broadcasts

POST/broadcasts/:id/start

Start the send (projected volume checked against your plan). broadcasts

POST/broadcasts/:id/test

Send a test preview. broadcasts

POST/broadcasts/:id/cancel

Cancel a running send. broadcasts

POST/broadcasts/:id/duplicate

Duplicate a broadcast. broadcasts

GET/broadcasts/:id/domainstats

Per-domain delivery stats. analytics

GET/broadcasts/:id/clientstats

Per-email-client stats. analytics

Webhooks

Plan-gated: requires webhooks on your plan.

GET/webhooks

List registered webhooks. webhooks

POST/webhooks

PATCH/webhooks/:id

Update a webhook. webhooks

DELETE/webhooks/:id

Remove a webhook. webhooks

Suppression lists

GET/supplists

List suppression lists. contacts

POST/supplists

Create a suppression list. contacts

PATCH/supplists/:id

Update a suppression list. contacts

DELETE/supplists/:id

Delete a suppression list. contacts

Exports & routes

GET/exports

List export jobs and download links. analytics

GET/routes

List sending routes available to your workspace. any