Set Domain Forwarding

POST

/domains/add-forwarding

Enables, updates, or removes URL forwarding for one or more domains.

Enable / update forwarding

Provide a URL in forwardTo. All traffic to the domain will be redirected to that URL.

{ "domains": ["acmecorp.com"], "forwardTo": "https://www.mysite.com" }

Disable forwarding

Set forwardTo to null to remove forwarding.

{ "domains": ["acmecorp.com"], "forwardTo": null }

Note: Changes apply asynchronously.

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Domain forwarding will update soon

Bodyapplication/json

🟠422Unprocessable Entity

🟠404Not Found

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Domain forwarding will update soon",
    "data": null,
    "actionId": "ACT_7a078272-0fa7-4db4-a85b-c78697dacea1"
}

Modified at 2026-08-10 11:13:04

Check Workspace Existence

Set Email Forwarding

Set Domain Forwarding

Enable / update forwarding#

Disable forwarding#

Request

Responses

Enable / update forwarding

Disable forwarding