Sign in

v1

latestOpenAPI 3.1.02026-07-24700259.3 KB
ALLOWED SENDERS

Update allowed senders

Replace the email addresses and domain names on your Allowed or Restricted Senders List using this endpoint. How the email addresses and domain names are used is defined in the current 'mode' value - further details of these modes are found in the SMPT2GO Guides. Note that a post to this endpoint will return a success, even if the setting is not in use.

post/allowed_senders/update

Request body

allowed_sendersstring[] required

Array of email addresses and domain names.

mode'whitelist' | 'blacklist' | 'disabled' required

A string indicating how the list of email address and domain names is interpreted. and should be one of 'whitelist', 'blacklist' or 'disabled'.<br><strong>Warning:</strong> Changing the mode to 'whitelist' or 'blacklist' disables the 'Sender Domains' and 'Single Sender Emails' features.<br>

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"
  }
}