Add domain forwarding

POST

/domains/add-forwarding

Configures forwarding settings for one or more domains. This endpoint should be used after receiving the domain.order.success webhook event.

Request Body

Parameter	Type	Required	Description
`domains`	`array`	Yes	List of domain names to configure forwarding for. Each name must be a valid domain format.
`forwardTo`	`string \| null`	Yes	The destination URL where the domain(s) should redirect to. Set to `null` to remove forwarding.

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

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

Body Params application/json

Example

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "message": "Domain forwarding will update soon",
    "data": null
}

🟠422 Unprocessable Entity

🟠404Not Found

Modified at 2025-10-29 17:06:05

Check If Google Workspace Exists

Add email forwarding

Add domain forwarding

Request Body#

Request

Request Code Samples

Responses

Request Body