Suppressions
Addresses Lockally will not send to. Bounces and complaints add themselves.
Every endpoint needs Authorization: Bearer lk_live_.... See
Conventions for headers, status codes
and error shape.
List suppressed recipients
GET /v1/suppressions · scope suppressions:read
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
reason |
query | string (unsubscribe, complaint, bounce, manual) |
|
cursor |
query | string | |
limit |
query | integer |
Response 200
Suppressions.
| Field | Type | Notes |
|---|---|---|
data |
array of Suppression | |
next_cursor |
string |
Errors: 401
Add a suppression
POST /v1/suppressions · scope suppressions:write
Request body
| Field | Type | Notes |
|---|---|---|
email |
string | Required. |
reason |
string (unsubscribe, complaint, bounce, manual) |
Response 201
Added.
| Field | Type | Notes |
|---|---|---|
email |
string | |
reason |
string (unsubscribe, complaint, bounce, manual) |
|
source |
string | |
created_at |
string |
Errors: 400
Check whether an address is suppressed
GET /v1/suppressions/{email} · scope suppressions:read
Response 200
Suppressed.
| Field | Type | Notes |
|---|---|---|
email |
string | |
reason |
string (unsubscribe, complaint, bounce, manual) |
|
source |
string | |
created_at |
string |
Errors: 404
Remove a suppression
DELETE /v1/suppressions/{email} · scope suppressions:write
Response 204
Removed.
Errors: 404