Create a recipient

PUT 
/users

Create a recipient

Request

Query Parameters

email_address stringrequired

The email address of the user to add

admin booleanrequired

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

filter string
Possible values: [true, false, compute]
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.

application/json

Body

list_entries

object

safelist and blocklist entries to be added

blocklist string[]

safelist string[]

Responses

200

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

201

The recipient was created successfully.

application/json

Schema

Schema

recipient

email_address stringrequired

the email address of the user

roles string[]required

array of roles the given user has

filter booleannullable

determines if policy should be applied to messages intended for this recipient

list_entries

undefined[]

Array [

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.

]

Example (from schema)

{
  "recipient": {
    "email_address": "string",
    "roles": [
      "string"
    ],
    "filter": true
  },
  "list_entries": [
    {
      "item": "string",
      "item_type": "string",
      "action": "string"
    }
  ]
}

400

Returned when the email_address is invalid.

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

403

Retuned when customer/API-key does not have the required privileges to make this request. Also returned when an account is created with filter = true and there is no room in the protected-addresses limit to filter mail for more recipients

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

500

Internal Server Error

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

Loading...