Add email forwarding

POST

/domains/add-email-forwarding

Configures email forwarding at the domain level, allowing incoming emails to be automatically redirected to a single destination email address.

Note: This feature is available for both Google and Outlook .

Enable or update forwarding

Provide a valid email address in the email field. All applicable mailboxes under the given domain(s) will forward emails to that address.

{
  "domains": ["example.com"],
  "email": "inbox@yourcompany.com"
}

Disable forwarding

To remove forwarding, use the same domains and do one of the following:

set "email": null

{
  "domains": ["example.com"],
  "email": null
}

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

cmr-x-api-key: ********************

Body Params application/json

Example

{
    "domains": [
        "string"
    ],
    "email": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/domains/add-email-forwarding' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "domains": [
        "string"
    ],
    "email": "string"
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Examples

SuccessNot FoundExample 1

{
    "status": 200,
    "message": "Email forwarding will be activated shortly.",
    "data": {
        "domains": [
            "bestpremium.org"
        ],
        "email": "example@company.com"
    },
    "actionId": "ACT_7a078272-0fa7-4db4-a85b-c78697dacea1"
}

🟠404Not Found

🟠422Unprocessable Entity

Modified at 2026-06-23 16:21:02

Add domain forwarding

Add Google Client ID to Domain