Warm-up plan
The warm-up plan object
Attributes
projectIdstring (uuid)requiredIdentifier of the Polymorfa project that owns this resource.
planobjectrequiredStructured plan values for this native project warmup plan.
Show 3 child fields
ceilingintegerrequiredmin1Specifies ceiling for this native project warmup plan.
curvearray of objectrequiredmax items91Curve associated with this native project warmup plan.
Show 2 child fields
entitledbooleanrequiredWhether entitled.
entitlementReasonstringrequirednullableSpecifies entitlement reason for this native project warmup plan.
{
"projectId": "00000000-0000-4000-8000-000000000000",
"plan": {
"enabled": true,
"warmupDays": 1,
"dailyStart": 1
},
"ceiling": 1,
"curve": [
{
"day": 0,
"allowance": 0
}
],
"entitled": true,
"entitlementReason": "string"
}Get project warmup plan
- Base URL
https://api.polymorfa.com- Required permission
sessions:read
Path parameters
projectIdstring (uuid)requiredIdentifier of the Polymorfa project that owns this resource.
Responses
200Project warm-up plan, its projected curve, and whether the plan includes BanSafe Lite
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 6 child fields
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
curl "https://api.polymorfa.com/messaging/projects/<projectId>/warmup-plan" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": {
"projectId": "00000000-0000-4000-8000-000000000000",
"plan": {
"enabled": true,
"warmupDays": 1,
"dailyStart": 1
},
"ceiling": 1,
"curve": [
{
"day": 0,
"allowance": 0
}
],
"entitled": true,
"entitlementReason": "string"
}
}Update project warmup plan
- Base URL
https://api.polymorfa.com- Required permission
sessions:manage
Turns the warm-up plan on or off for a project and sets how long the ramp takes and how many messages a number may send on its first day. While the plan is on, a send past a number's allowance is refused with bansafe_daily_allowance_reached and campaign recipients are deferred to the next reset.
Path parameters
projectIdstring (uuid)requiredIdentifier of the Polymorfa project that owns this resource.
Body
enabledbooleanWhether this feature is enabled.
warmupDaysintegerrange1–90Specifies warmup days for this schema.
dailyStartintegerrange1–2000Specifies daily start for this schema.
Responses
200Project warm-up plan updated
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 6 child fields
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
402`warmup_plan_not_entitled`: the warm-up plan is part of BanSafe Lite, which is not included on this project's plan
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
503Stored, but a connected number did not confirm the plan; retry the request
curl -X PUT "https://api.polymorfa.com/messaging/projects/<projectId>/warmup-plan" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"enabled": true,
"warmupDays": 1,
"dailyStart": 1
}'{
"success": true,
"data": {
"projectId": "00000000-0000-4000-8000-000000000000",
"plan": {
"enabled": true,
"warmupDays": 1,
"dailyStart": 1
},
"ceiling": 1,
"curve": [
{
"day": 0,
"allowance": 0
}
],
"entitled": true,
"entitlementReason": "string"
}
}