Pause warmup to Bulk pause warmup
Stops warmup sending on a mailbox but keeps its settings and progress. Call "Resume warmup" to continue.
Pause warmup
Stops warmup sending on a mailbox but keeps its settings and progress. Call "Resume warmup" to continue.
| Old API | New API | |
|---|---|---|
| Method + route | POST /v1/warmup-settings/{emailAccountId}/stop | POST /v2/workspaces/{workspaceId}/accounts/{id}/warmup/pause |
| Key permission (scope) | any key | warmup:manage |
| Rate bucket | 20/min shared | write |
| Plan needed | - | - |
What changed
- Renamed from
stoptopause. There is no body. - The response is the full email account object in
data(the old call returned an empty 200). - Old 422
warmup_not_active→ new 400invalid_request("already paused or not started"). - To start again, call
resume, notenable.
Path and query parameters
| Name | In | Type | Required | Default / limits | What it means | Old name |
|---|---|---|---|---|---|---|
workspaceId | path | number | yes | - | Your TrulyInbox workspace id. | - |
id | path | number | yes | - | The email account id. | emailAccountId |
Request body
No body.
Example request (new)
curl -X POST "$TI_BASE_URL/v2/workspaces/42/accounts/123/warmup/pause" \
-H "Authorization: Bearer ti_ws_your_key"Example request (old)
curl -X POST "https://lupus-edge.trulyinbox.com/v1/warmup-settings/123/stop" \
-H "X-Api-Key: YOUR_API_KEY"Response (new)
200 OK. data is the full email account, the same as "Get warmup status". warmupStatus can show the old value for a few seconds, until the warmup worker processes the change.
{
"data": {
"id": 123,
"emailAddress": "jane@acme.com",
"warmupStatus": "PAUSED",
"warmupPausedReason": null,
"warmupCurrentLimit": 18
},
"meta": {
"request_id": "req_9a1e6b02",
"timestamp": "2026-09-29T10:00:00.000Z"
}
}(Shortened: the real response has every account field.)
Response (old)
Empty 200 (no body documented).
Errors you should handle
| HTTP | error.code | When it happens | What to do |
|---|---|---|---|
| 400 | invalid_request | Warmup is already paused or has not started. | Nothing to do; read the state with "Get warmup status". |
| 401 | unauthorized / invalid_api_key | Key missing, wrong or revoked. | Check the Authorization: Bearer header. |
| 403 | insufficient_scope | Key has no warmup:manage scope. | Add the scope to the key. |
| 403 | workspace_forbidden | Key cannot access this workspace. | Use a key for this workspace. |
| 403 | forbidden | The key's user is below editor role. | Use a key with editor rights. |
| 403 | subscription_paused | The subscription is paused. | Resume the subscription. |
| 404 | not_found | No account with this id in this workspace. | Check workspaceId and id. |
| 409 | conflict | A bulk action is running on this mailbox. | Wait and retry. |
| 429 | rate_limit_exceeded | Write bucket is empty. | Wait error.retry_after seconds. |
Resume warmup
Restarts warmup on a mailbox you paused, or one the system suspended for a reason you can clear. It continues from where the ramp stopped.
| Old API | New API | |
|---|---|---|
| Method + route | none - new (the old start covered this) | POST /v2/workspaces/{workspaceId}/accounts/{id}/warmup/resume |
| Key permission (scope) | none - new | warmup:manage |
| Rate bucket | none - new | write |
| Plan needed | none - new | - (the number of warming mailboxes is capped by plan) |
What changed
- New call. In the old API you called
startagain afterstop. Now useresumeafterpause. - Some suspensions (for example high bounce or spam rates) cannot be resumed by hand. They clear by themselves when the problem recovers; resume returns 400
invalid_request. - Resume does not re-check DNS. If a required DNS record is failing, run the DNS re-check first, then resume.
- The response is the full email account object in
data.
Path and query parameters
| Name | In | Type | Required | Default / limits | What it means | Old name |
|---|---|---|---|---|---|---|
workspaceId | path | number | yes | - | Your TrulyInbox workspace id. | - |
id | path | number | yes | - | The email account id. | - |
Request body
No body.
Example request (new)
curl -X POST "$TI_BASE_URL/v2/workspaces/42/accounts/123/warmup/resume" \
-H "Authorization: Bearer ti_ws_your_key"Response (new)
200 OK. data is the full email account, the same as "Get warmup status". warmupStatus can show the old value for a few seconds, until the warmup worker processes the change.
{
"data": {
"id": 123,
"emailAddress": "jane@acme.com",
"warmupStatus": "RUNNING",
"warmupPausedReason": null,
"warmupCurrentLimit": 18
},
"meta": {
"request_id": "req_5f7a0c44",
"timestamp": "2026-09-29T10:00:00.000Z"
}
}(Shortened: the real response has every account field.)
Errors you should handle
| HTTP | error.code | When it happens | What to do |
|---|---|---|---|
| 400 | invalid_request | The mailbox is not paused or suspended; the suspension clears only by itself; or the address hard-bounced repeatedly and was removed from warmup. | Read error.message. Wait, or fix the mailbox. |
| 401 | unauthorized / invalid_api_key | Key missing, wrong or revoked. | Check the Authorization: Bearer header. |
| 403 | insufficient_scope | Key has no warmup:manage scope. | Add the scope to the key. |
| 403 | workspace_forbidden | Key cannot access this workspace. | Use a key for this workspace. |
| 403 | warmup_limit_reached | Your plan already warms the maximum number of mailboxes. | Pause another mailbox, or upgrade. |
| 403 | forbidden | A required DNS record is failing; or the key's user is below editor role. | Fix DNS, run the DNS re-check, then resume. |
| 403 | subscription_paused | The subscription is paused. | Resume the subscription. |
| 404 | not_found | No account with this id in this workspace. | Check workspaceId and id. |
| 409 | conflict | A bulk action is running on this mailbox. | Wait and retry. |
| 429 | rate_limit_exceeded | Write bucket is empty. | Wait error.retry_after seconds. |
Bulk start warmup
Starts warmup on many mailboxes in one call. Mailboxes that cannot start are listed in failed; the others still start.
| Old API | New API | |
|---|---|---|
| Method + route | POST /v1/warmup-settings/bulk-action with "action": "start" | POST /v2/workspaces/{workspaceId}/accounts/bulk/warmup/enable |
| Key permission (scope) | any key | warmup:manage |
| Rate bucket | 20/min shared | bulk |
| Plan needed | - | - (the number of warming mailboxes is capped by plan) |
What changed
- The old call is split in two: this one (start) and "Bulk pause warmup". There is no
actionfield. emailAccountIds→ids. The limit is now 200 ids (was 50).tagsis gone. To act on a tag, first list ids withGET /v2/workspaces/{workspaceId}/accounts?tags=sales, then send those ids.- Response
results[](emailAccountId,status,error_code,message) →succeeded(list of ids) andfailed(list of{ id, error }). - Each id goes through the same checks as "Start warmup" (DNS, send/receive check, plan cap). Ids are processed one by one, so the plan cap is respected.
- Bulk enable does not resume paused mailboxes; they appear in
failed. Resume them one by one with "Resume warmup".
Path and query parameters
| Name | In | Type | Required | Default / limits | What it means | Old name |
|---|---|---|---|---|---|---|
workspaceId | path | number | yes | - | Your TrulyInbox workspace id. | - |
Request body
| New field | Type | Required | Allowed values / limits | What it means | Old field |
|---|---|---|---|---|---|
ids | integer[] | yes | 1–200 ids, no duplicates | Email account ids to start. | emailAccountIds (max 50) |
Removed: action, tags. Sending them fails with 400 invalid_request.
Example request (new)
curl -X POST "$TI_BASE_URL/v2/workspaces/42/accounts/bulk/warmup/enable" \
-H "Authorization: Bearer ti_ws_your_key" \
-H "Content-Type: application/json" \
-d '{ "ids": [123, 124, 125] }'Example request (old)
curl -X POST "https://lupus-edge.trulyinbox.com/v1/warmup-settings/bulk-action" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "emailAccountIds": [123, 124, 125], "action": "start" }'Response (new)
200 OK, even when some ids fail.
| New field (inside data) | Type | What it means | Old field |
|---|---|---|---|
succeeded | number[] | Ids where warmup was started. | results[] with status: "ok" |
failed | object[] | Ids that were not started. | results[] with status: "error" |
failed[].id | number | The id. | results[].emailAccountId |
failed[].error | string | Short machine-readable reason. | results[].error_code |
failed[].error is not one of the public error.code values, so do not branch on its exact text. Treat any entry in failed as "not started". To learn why, call "Start warmup" on that id alone; it returns the public error.code (for example mailbox_verification_pending or warmup_limit_reached).
{
"data": {
"succeeded": [123, 124],
"failed": [
{ "id": 125, "error": "<reason code>" }
]
},
"meta": {
"request_id": "req_0c4f7e18",
"timestamp": "2026-09-29T10:00:00.000Z"
}
}Response (old)
{
"results": [
{ "emailAccountId": 123, "status": "ok" },
{ "emailAccountId": 125, "status": "error", "error_code": "warmup_already_active", "message": "Warmup is already active." }
]
}Errors you should handle
| HTTP | error.code | When it happens | What to do |
|---|---|---|---|
| 400 | invalid_request | ids missing, empty, over 200, has duplicates, or old fields (action, tags, emailAccountIds) sent. | Fix the body. |
| 401 | unauthorized / invalid_api_key | Key missing, wrong or revoked. | Check the Authorization: Bearer header. |
| 403 | insufficient_scope | Key has no warmup:manage scope. | Add the scope to the key. |
| 403 | workspace_forbidden | Key cannot access this workspace. | Use a key for this workspace. |
| 403 | subscription_paused | The subscription is paused. | Resume the subscription. |
| 429 | rate_limit_exceeded | Bulk bucket is empty. | Wait error.retry_after seconds. |
Bulk pause warmup
Pauses warmup on many mailboxes in one call. Mailboxes that cannot be paused are listed in failed; the others are still paused.
| Old API | New API | |
|---|---|---|
| Method + route | POST /v1/warmup-settings/bulk-action with "action": "stop" | POST /v2/workspaces/{workspaceId}/accounts/bulk/warmup/pause |
| Key permission (scope) | any key | warmup:manage |
| Rate bucket | 20/min shared | bulk |
| Plan needed | - | - |
What changed
- The old call is split in two: this one (pause) and "Bulk start warmup". There is no
actionfield. emailAccountIds→ids. The limit is now 200 ids (was 50).tagsis gone. List ids first withGET /v2/workspaces/{workspaceId}/accounts?tags=sales.- Response is
succeeded(ids) andfailed({ id, error }), notresults[].
Path and query parameters
| Name | In | Type | Required | Default / limits | What it means | Old name |
|---|---|---|---|---|---|---|
workspaceId | path | number | yes | - | Your TrulyInbox workspace id. | - |
Request body
| New field | Type | Required | Allowed values / limits | What it means | Old field |
|---|---|---|---|---|---|
ids | integer[] | yes | 1–200 ids, no duplicates | Email account ids to pause. | emailAccountIds (max 50) |
Removed: action, tags. Sending them fails with 400 invalid_request.
Example request (new)
curl -X POST "$TI_BASE_URL/v2/workspaces/42/accounts/bulk/warmup/pause" \
-H "Authorization: Bearer ti_ws_your_key" \
-H "Content-Type: application/json" \
-d '{ "ids": [123, 124, 125] }'Example request (old)
curl -X POST "https://lupus-edge.trulyinbox.com/v1/warmup-settings/bulk-action" \
-H "X-Api-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "emailAccountIds": [123, 124, 125], "action": "stop" }'Response (new)
200 OK, even when some ids fail.
| New field (inside data) | Type | What it means | Old field |
|---|---|---|---|
succeeded | number[] | Ids where warmup was paused. | results[] with status: "ok" |
failed | object[] | Ids that were not paused (for example already paused, or not found). | results[] with status: "error" |
failed[].id | number | The id. | results[].emailAccountId |
failed[].error | string | Short machine-readable reason. | results[].error_code |
failed[].error is not one of the public error.code values, so do not branch on its exact text. Call "Pause warmup" on that id alone to get the public error.code.
{
"data": {
"succeeded": [123, 124],
"failed": [
{ "id": 125, "error": "<reason code>" }
]
},
"meta": {
"request_id": "req_7b2e9d31",
"timestamp": "2026-09-29T10:00:00.000Z"
}
}Response (old)
{
"results": [
{ "emailAccountId": 123, "status": "ok" },
{ "emailAccountId": 125, "status": "error", "error_code": "warmup_not_active", "message": "Warmup is not active." }
]
}Errors you should handle
| HTTP | error.code | When it happens | What to do |
|---|---|---|---|
| 400 | invalid_request | ids missing, empty, over 200, has duplicates, or old fields sent. | Fix the body. |
| 401 | unauthorized / invalid_api_key | Key missing, wrong or revoked. | Check the Authorization: Bearer header. |
| 403 | insufficient_scope | Key has no warmup:manage scope. | Add the scope to the key. |
| 403 | workspace_forbidden | Key cannot access this workspace. | Use a key for this workspace. |
| 403 | subscription_paused | The subscription is paused. | Resume the subscription. |
| 429 | rate_limit_exceeded | Bulk bucket is empty. | Wait error.retry_after seconds. |