Skip to main content
PUT
Create a recipient

Authorizations

X-API-Key
string
header
required

Query Parameters

email_address
string
required

The email address of the user to add

admin
boolean
required

Flag to indicate if the user is a domain admin or a regular user

filter
enum<string>

Whether or not to filter mail for this recipient. There are three valid values.

  • true - Filtering policy will be applied to messages intended for this recipient. If this would exceed the protected-addresses limit, return an error.
  • false - Filtering policy will not be applied to messages intended for this recipient.
  • compute (default) - Filtering policy will be applied to messages intended for this recipient. If this would exceed the protected-addresses limit, filtering policy will not be applied, and no error will be returned.
Available options:
true,
false,
compute

Body

application/json
list_entries
object

safelist and blocklist entries to be added

Response

Returned in the case where the recipient already exists and in that case no changes will be made to the safe/block list entries.