Lists & contacts

Your audience lives in lists. Broadcasts target lists; suppression lists keep people who opted out from ever being emailed again.

Audience endpoints require a key with the contacts scope.

Lists

GET/lists

POST/lists

GET/lists/:id

PATCH/lists/:id

DELETE/lists/:id

curl

curl -X POST https://api.inbuzzed.com/api/v1/esp/lists \
  -H "X-Api-Key: ib_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "name": "Newsletter subscribers" }'

Add contacts

POST/lists/:listId/feed

curl

curl -X POST https://api.inbuzzed.com/api/v1/esp/lists/list_123/feed \
  -H "X-Api-Key: ib_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "email": "ada@example.com",
    "data": { "firstname": "Ada" },
    "tags": ["newsletter"]
  }'

emailstringrequired

The contact's email address.

dataobject

Custom field values, keyed by field name — string values only. Anything besides email goes here, never top-level.

tagsstring[]

Tags to apply to the contact.

removetagsstring[]

Tags to remove from the contact.

resubscribeboolean

Re-activate a previously unsubscribed contact.

unsubscribeboolean

Mark the contact unsubscribed.

Read a list

GET/lists/:id/feed

Returns the list's contacts, newest first. Page backwards with ?older= using the cursor from the previous page.

Suppression lists

Suppression lists are exclusion sets: attach them to a broadcast via supplists and their members are skipped.

GET/supplists

POST/supplists

PATCH/supplists/:id

DELETE/supplists/:id

Exports

POST/lists/:id/export

GET/exports

Exports run asynchronously — request one, then poll /exports for the download (requires the analytics scope).