Cancel Warmup for Mailboxes

POST

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

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

🟢200Success 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/cancel' \
--header 'X-Workspace-Id;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mailbox_uids": [
        "string"
    ]
}'

Response Example

200 - Example 1

{
    "error": false,
    "message": "Processed 2 mailbox(es): 2 cancelled, 0 failed",
    "results": {
        "success": [
            {
                "mailbox_uid": "mb-123e4567-e89b-12d3-a456-426614174000",
                "subscription_uid": "ws-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
                "action": "cancelled"
            }
        ],
        "failed": [
            {
                "mailbox_uid": "mb-failed-uid",
                "reason": "Subscription is already cancelled"
            }
        ]
    },
    "summary": {
        "total_requested": 2,
        "success_count": 2,
        "failed_count": 0
    }
}

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

Resume Warmup for Mailboxes

Get Warmup Statistics