v1

latestOpenAPI 3.1.02026-07-24700259.3 KB
ALLOWED SENDERS

Add allowed senders

Add one or more email addresses and domain names to your Allowed or Restricted Senders List. How this list of email addresses and domain names are used is shown by the current 'mode' value; if the Restrict Senders setting is on, they will form either a whitelist or blacklist. If the setting is off, the list will be disabled. Further details of the associated setting are found in the SMTP2GO Guides. Details of how this mode can be set via the update end-point, are given further in the documentation. A post to this endpoint will return a success, even if the Restrict Senders setting is not in use.

post/allowed_senders/add

Request body

allowed_sendersstring[] required

Array of email addresses and domain names.

subaccount_idstring

If you wish to make this API call on behalf of a subaccount then include its unique ID here

Response

Allowed Senders list updated

request_idstring required

Example response

{
  "request_id": "40cbb6f2-935f-11e7-b5be-480fcf01a6f2",
  "data": {
    "allowed_senders": [
      "test-person@example.com"
    ],
    "mode": "whitelist"
  }
}