ALLOWED RECIPIENTS

Update allowed recipients

Replace the email addresses and domain names on your Allowed Recipients List using this endpoint. 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_recipients/update

Request

Base URL
https://api.smtp2go.com/v3
Auth
- API key in header X-Smtp2go-Api-Key
- or HTTP bearer
TypeScript
https://skmtc.dev/smtp2go/apis/smtp2go-api-v3-0-4/docs/allowed_recipients/update/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

allowed_recipientsstring[] required

Array of email addresses and domain names.

enabledboolean required

A flag indicating if this list should be taken into account when sending

subaccount_idstring

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

Example request

{
  "enabled": true
}

Response

Allowed Recipients list updated

request_idstring required

Example response

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

Changes

No recorded changes to this operation across all 2 revisions of this API.