Blocklist
This section allows you to manage the blocklist of your emails.
List blocklists
Retrieve the list of blocklists.
path Parameters
regionThe region you want to target
query Parameters
domain_id(Optional) Filter by a domain ID. (UUID format)
order_by(Optional) List blocklist corresponding to specific criteria.
page(Optional) Requested page number. Value must be greater or equal to 1.
page_size(Optional) Requested page size. Value must be between 1 and 100.
email(Optional) Filter by an email address.
type(Optional) Filter by a blocklist type.
custom(Optional) Filter by custom blocklist (true) or automatic Transactional Email blocklist (false).
List blocklists › Responses
total_countNumber of blocklists matching the requested criteria.
Single page of blocklists matching the requested criteria.
Bulk create blocklists
Create multiple blocklists in a specific Project or Organization using the region parameter.
path Parameters
regionThe region you want to target
Bulk create blocklists › Request Body
domain_idDomain ID linked to the blocklist. (UUID format)
emailsEmail blocked by the blocklist.
typeType of blocklist.
reasonReason to block the email.
Bulk create blocklists › Responses
List of blocklist created.
Delete a blocklist
You must specify the blocklist you want to delete by the region and blocklist_id.
path Parameters
regionThe region you want to target
blocklist_idID of the blocklist to delete. (UUID format)