Add Warmup to Mailboxes

POST

https://api.inboxkit.com/v1/api/warmup/add

Maintainer:Not configured

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Body Params application/json

Examples

Responses

🟢201Success Response

application/json

Body

🟠400Bad Request

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.inboxkit.com/v1/api/warmup/add' \
--header 'X-Workspace-Id;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mailbox_uids": [
        "string"
    ],
    "activate_immediately": false
}'

Response Example

201 - Example 1

{
    "error": false,
    "message": "Created 3 warmup subscription(s)",
    "subscriptions": [
        {
            "uid": "ws-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "status": "active",
            "mailbox_email": "[email protected]",
            "price_per_month": 3,
            "started_at": null,
            "next_billing_date": "2025-02-15T10:30:00.000Z",
            "createdAt": "2025-01-15T10:30:00.000Z"
        }
    ],
    "errors": [
        {
            "mailbox_uid": "mb-failed-uid",
            "error": "Error creating subscription"
        }
    ],
    "skipped": 1
}

Modified at 2026-02-17 17:06:45

Get Warmup Subscription Details

Pause Warmup for Mailboxes