Enable or disable domain auto-renew

PATCH

/domains/toggle-auto-renew

This endpoint allows you to enable or disable auto-renew for domain names associated with your users.

When Auto-Renew is Enabled

The system automatically queues domain renewal requests based on eligibility criteria, such as:

Approaching expiry date

Being within the grace period

When Auto-Renew is Disabled

The domain is excluded from the automated renewal process and will require manual intervention for renewal.

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

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

Body Params application/jsonRequired

Examples

Example 1Example 2

{
    "userId": "8J7HM04FRXUT4VK86128K6D25APS",
    "domains": [
        "hefty-minion.net",
        "sparkling-disk.info",
        "favorite-hydrolyse.name"
    ],
    "autoRenew": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Example 1Example 2

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-raw '{
    "userId": "8J7HM04FRXUT4VK86128K6D25APS",
    "domains": [
        "hefty-minion.net",
        "sparkling-disk.info",
        "favorite-hydrolyse.name"
    ],
    "autoRenew": true
}'

Responses

🟢200Success

application/json

Body

{
    "status": 200,
    "message": "Auto-renew toggled on for 1 domain.",
    "data": [
        {
            "domainName": "acme.com",
            "domainId": "5J7HM04FRXMT7VK86128K6D25ASP",
            "autoRenew": true
        }
    ]
}

🟠422Unprocessable Entity

🟠404Not Found

Modified at 2026-04-03 10:29:50

Renew domain

Get Domains For User