Migrating from v1Warmup
Get warmup settings
Returns the warmup configuration of one mailbox, plus the plan caps on its limit and reply rate.
Get warmup settings
Returns the warmup configuration of one mailbox, plus the plan caps on its limit and reply rate.
| Old API | New API | |
|---|---|---|
| Method + route | GET /v1/warmup-settings/{emailAccountId} | GET /v2/workspaces/{workspaceId}/accounts/{id}/warmup/settings |
| Key permission (scope) | any key | warmup:read |
| Rate bucket | 20/min shared | read |
| Plan needed | - | - |
What changed
- Many fields are renamed. See the table below and the "Update warmup settings" section.
timeSlots→schedule, and days are numbered differently: old0= Sunday, new0= Monday.googleVolumePercentage/microsoftVolumePercentage/othersVolumePercentage→espGooglePct/espMicrosoftPct/espOthersPct, plusespMode(AUTOorCUSTOM).upcomingContentConfig { industry, topics }→ top-levelindustry,topics.warmupStatusis no longer here. Read it from "Get warmup status".
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 GET "$TI_BASE_URL/v2/workspaces/42/accounts/123/warmup/settings" \
-H "Authorization: Bearer ti_ws_your_key"Example request (old)
curl -X GET "https://lupus-edge.trulyinbox.com/v1/warmup-settings/123" \
-H "X-Api-Key: YOUR_API_KEY"Response (new)
200 OK.
| New field (inside data) | Type | What it means | Old field |
|---|---|---|---|
warmupMaxLimit | number | Your maximum daily warmup sends. | maxSendingLimit |
maxWarmupPerAccount | number or null | Plan cap for warmupMaxLimit. null = no cap. | - |
replyRateCap | number or null | Plan cap for a custom reply rate (%). null = no cap. | - |
espMode | string | AUTO or CUSTOM ESP split. | - |
espGooglePct / espMicrosoftPct / espOthersPct | number or null | Share (%) of warmup volume to Google, Microsoft and other ESPs. | googleVolumePercentage / microsoftVolumePercentage / othersVolumePercentage |
language | string | Language of warmup emails. | warmupLanguage |
industry | string or null | Industry for content. | upcomingContentConfig.industry |
topics | string[] | Topics for content. | upcomingContentConfig.topics |
templateLabels | array of {id, name} | Template labels (shown as "groups" in the UI) this mailbox draws from. Empty = AI content only. | - |
templatePool | {count, templates} | READY templates sharing at least one of the mailbox's template labels. count is exact; templates ({id, name}) is capped at 50. | - |
templateRatioPercent | number | Chance (%) that one send uses a template instead of AI content. | - |
timezone | string | IANA timezone of the schedule. | timeZone |
schedule | object[] | Weekly sending windows, 1–2 slots per day. | timeSlots |
schedule[].dayOfWeek | number | 0 = Monday … 6 = Sunday. | timeSlots[].day (0 = Sunday!) |
schedule[].slotIndex | number | 0 or 1, in time order. | - |
schedule[].weight | number | Share (%) of the day's volume for this slot. | - |
schedule[].enabled | boolean | Warmup sends on this day. | timeSlots[].isEnabled |
schedule[].startTime / endTime | string | Window as "HH:MM". | fromHour+fromMinute / toHour+toMinute |
senderName | string or null | Sender name on warmup emails. | - |
dkimSelector | string or null | Custom DKIM selector. | - |
warmupFolder | string or null | Folder warmup emails are filed into. | - |
Old dailySendingLimit is now warmupCurrentLimit on "Get warmup status". Old warmUpInitialSendingLimit, replyRate, strategy, increaseEmailsByNumber and dailyReceivingLimit have no field in this response.
{
"data": {
"warmupMaxLimit": 40,
"maxWarmupPerAccount": 50,
"replyRateCap": 65,
"dkimSelector": null,
"senderName": "Jane Cooper",
"warmupFolder": null,
"espMode": "CUSTOM",
"espGooglePct": 60,
"espMicrosoftPct": 30,
"espOthersPct": 10,
"language": "English",
"industry": "SaaS",
"topics": ["Digital Transformation", "Industry News"],
"timezone": "America/New_York",
"schedule": [
{ "dayOfWeek": 0, "slotIndex": 0, "weight": 100, "enabled": true, "startTime": "09:00", "endTime": "17:30" },
{ "dayOfWeek": 1, "slotIndex": 0, "weight": 100, "enabled": true, "startTime": "09:00", "endTime": "17:00" },
{ "dayOfWeek": 2, "slotIndex": 0, "weight": 100, "enabled": true, "startTime": "09:00", "endTime": "17:00" },
{ "dayOfWeek": 3, "slotIndex": 0, "weight": 100, "enabled": true, "startTime": "09:00", "endTime": "17:00" },
{ "dayOfWeek": 4, "slotIndex": 0, "weight": 100, "enabled": true, "startTime": "09:00", "endTime": "17:00" },
{ "dayOfWeek": 5, "slotIndex": 0, "weight": 100, "enabled": false, "startTime": "09:00", "endTime": "17:00" },
{ "dayOfWeek": 6, "slotIndex": 0, "weight": 100, "enabled": false, "startTime": "09:00", "endTime": "17:00" }
],
"templateLabels": [],
"templatePool": { "count": 0, "templates": [] },
"templateRatioPercent": 0
},
"meta": {
"request_id": "req_1a9f3c77",
"timestamp": "2026-09-29T10:00:00.000Z"
}
}Response (old)
{
"emailAccountId": 123,
"strategy": "progressive",
"timeZone": "America/New_York",
"warmupStatus": "active",
"warmupLanguage": "English",
"upcomingContentConfig": {
"industry": "SaaS",
"topics": ["Digital Transformation", "Industry News"]
},
"googleVolumePercentage": 60,
"microsoftVolumePercentage": 30,
"othersVolumePercentage": 10,
"maxSendingLimit": 40,
"warmUpInitialSendingLimit": 5,
"increaseEmailsByNumber": 2,
"replyRate": 30,
"dailySendingLimit": 18,
"dailyReceivingLimit": 30
}Errors you should handle
| HTTP | error.code | When it happens | What to do |
|---|---|---|---|
| 401 | unauthorized / invalid_api_key | Key missing, wrong or revoked. | Check the Authorization: Bearer header. |
| 403 | insufficient_scope | Key has no warmup:read 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. |
| 404 | not_found | No account with this id in this workspace. | Check workspaceId and id. |
| 429 | rate_limit_exceeded | Read bucket is empty. | Wait error.retry_after seconds. |