Toggle Domain Auto-Renew

PATCH

/domains/toggle-auto-renew

Enables or disables automatic renewal for one or more domains.

Omit domains to apply the setting to all domains under the user. The response includes per-domain results.

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

Auto-renew toggled for the eligible domains. Per-domain outcomes are reported in data; this endpoint returns 200 even when some or all domains fail.

Bodyapplication/json

🟠404Not Found

🟠422Unprocessable Entity

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://customers.coldmailreseller.com/api/v1/integration/domains/toggle-auto-renew' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "userId": "H8M9JV2S9HMPYFQW393AZHQVD4XM",
    "domains": [
        "acmecorp.com"
    ],
    "autoRenew": true
}'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Auto-renew toggled on for 1 domain.",
    "data": [
        {
            "domainName": "acmecorp.com",
            "domainId": "string",
            "autoRenew": true,
            "renewalQueuedImmediately": true,
            "error": "string"
        }
    ],
    "actionId": "ACT_7a078272-0fa7-4db4-a85b-c78697dacea1"
}

Modified at 2026-08-06 06:20:56

Renew Domains

Get Domains by User