API reference

Suppression lists

Suppression lists hold addresses that should never be emailed. Paths are relative to https://app.blacklistguard.com/api/v1.

Lists

GET    /suppression-lists
POST   /suppression-lists
PUT    /suppression-lists/{id}
DELETE /suppression-lists/{id}

Returns { suppression_lists: [{ id, name, description, suppression_scope, mailing_list_name, entry_count, is_active, created_at }] }. Create with { name, description, suppression_scope }, where suppression_scope is global (applies to all your sending), mailing_list, or segment. For mailing_list scope also pass mailing_list_id; for segment scope also pass segment_id.

Entries

GET    /suppression-lists/{id}/entries
POST   /suppression-lists/{id}/entries
DELETE /suppression-lists/{id}/entries/{entry_id}

List returns up to 1,000 entries, newest first: [{ id, entry_value, entry_type, normalized_value, created_at, created_by }] (or null when empty).

Add takes one or more addresses, one per line:

POST /suppression-lists/{id}/entries
{ "entries": "old@example.com\nspam-trap@example.net" }

Returns { added, duplicates, message }.

Import a CSV

POST /suppression-lists/{id}/import   (multipart, field "csvFile")

Test an address

POST /suppression-lists/{id}/test
{ "test_value": "user@example.com" }

Returns { suppressed, test_value, reason } — a quick way to check whether a given address would be blocked.