Update Warmup Settings

Change the warmup settings of one or more mailboxes. Send only the settings you want to change. Everything you leave out stays as it is.

You can update mailboxes whose warmup is active, paused or waiting on a renewal payment. Mailboxes whose warmup has not started yet, and cancelled warmups, cannot be updated.

Starting volume

starting_volume only applies to the first day of warmup, so it can be changed only before warmup reaches day 2. After that it is skipped for that mailbox: the other settings in the request are still applied, and the response lists it under skipped_settings. If starting_volume is the only setting you send, that mailbox is reported as failed.

How the response works

If the request is invalid, for example a value is out of range, the whole request is refused with a 400 and no mailbox is changed.

Otherwise the response is 200 and lists every mailbox under results.success or results.failed. A request where some mailboxes fail still returns 200.

Why a mailbox can fail

`reason`	What to do
Mailbox not found or does not belong to your workspace	Check the mailbox UID and the `X-Workspace-Id` header.
No warmup subscription found for this mailbox	The mailbox has no warmup, or its warmup was cancelled. Add warmup first with Add Warmup to Mailboxes.
Warmup has not started for this mailbox yet	Try again once warmup has started for this mailbox.
starting_volume can only be changed before warmup reaches day 2	Leave `starting_volume` out of the request.
Could not update warmup settings for this mailbox. Please try again.	Send the request again. It is safe to repeat.

Reading settings back

The current settings of each mailbox are returned in cached_stats.config by Get Warmup Subscription Details and List Warmup Subscriptions.

Sending the same request again is safe. Requests with many mailboxes can take a little while to complete.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Responses

🟢200Success Response

application/json

The request was processed. Each mailbox is listed under results.success or results.failed. A request where some mailboxes fail still returns 200.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠429Too Many Requests

🔴500Internal Server Error

curl --location 'https://api.inboxkit.com/v1/api/warmup/update-settings' \ --header 'X-Workspace-Id;' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "mailbox_uids": [ "3b7e9c2a-5d41-4f8e-a6c3-1e2f7d9b0a54", "a41c8e67-2f90-4b3d-9e15-7c6a0d8b2f31", "e5d2b9f4-8a17-4c6e-b3d0-6f1a9c4e7b28" ], "settings": { "starting_volume": 12, "daily_increase": 3, "target_volume": 45, "reply_rates": { "inbox": { "min": 30, "max": 45 }, "promotions": { "min": 15, "max": 25 }, "spam": 100 } } }'

{ "error": false, "message": "Processed 3 mailbox(es): 2 updated, 1 failed", "results": { "success": [ { "mailbox_uid": "3b7e9c2a-5d41-4f8e-a6c3-1e2f7d9b0a54", "subscription_uid": "c7f3a1d9-4e62-4b8a-8d5f-2a9e6b1c3d70", "settings": { "starting_volume": 12, "daily_increase": 3, "target_volume": 45, "reply_rates": { "inbox": { "min": 30, "max": 45 }, "promotions": { "min": 15, "max": 25 }, "spam": 100 } } }, { "mailbox_uid": "a41c8e67-2f90-4b3d-9e15-7c6a0d8b2f31", "subscription_uid": "1d8b6e2f-9c34-4a7d-a2e8-5b0f3c9d6e14", "settings": { "daily_increase": 3, "target_volume": 45, "reply_rates": { "inbox": { "min": 30, "max": 45 }, "promotions": { "min": 15, "max": 25 }, "spam": 100 } }, "skipped_settings": [ "starting_volume" ] } ], "failed": [ { "mailbox_uid": "e5d2b9f4-8a17-4c6e-b3d0-6f1a9c4e7b28", "reason": "Warmup has not started for this mailbox yet" } ] }, "summary": { "total_requested": 3, "success_count": 2, "failed_count": 1 } }