Skip to main content
POST
Add item to recipient list

Authorizations

X-API-Key
string
header
required

Path Parameters

email
string
required

The email address of the recipient whose list will be modified.

listname
enum<string>
required

The name of the list to add an entry to. One of 'safelist' or 'blocklist'. 'whitelist' and 'blacklist' are deprecated

Available options:
blocklist,
safelist,
blacklist,
whitelist

Body

application/json
item
string
required

The value of the entry. The type of the entry is automatically determined based on the value.

Response

Successfully created the item

item
string

The value of this entry. The meaning of this value depends on the item_type.

item_type
string

The item type.

action
string

Which list this entry is on, e.g. safelist or blocklist.