Campaign settings
The team's contact frequency cap.
The campaign settings object
Attributes
launchApprovalobjectrequiredStructured launch approval values for this management campaign setting.
Show 1 child field
{
"launchApproval": {
"recipientThreshold": 1
}
}The frequency cap settings object
Attributes
teamIdstring (uuid)requiredIdentifier for the team.
maxPer24Hoursintegerrequirednullablerange1–50Most campaign messages one phone number receives from the team in any rolling 24 hours, 1 to 50.
nullsets no 24-hour limit.maxPer7Daysintegerrequirednullablerange1–200Most campaign messages one phone number receives from the team in any rolling 7 days, 1 to 200.
nullsets no 7-day limit. Must not be lower thanmaxPer24Hours.revisionintegerrequiredmin0Send this value back to change the cap. 0 until the team first saves.
updatedAtintegerrequirednullableformatint64Unix time in milliseconds of the last change; null until the team first saves.
{
"teamId": "00000000-0000-4000-8000-000000000000",
"maxPer24Hours": 1,
"maxPer7Days": 1,
"revision": 0,
"updatedAt": 0
}Get campaign settings
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Returns the team's campaign settings. launchApproval.recipientThreshold is the number of recipients above which a launch needs a team owner or admin; null means no launch needs approval. A team that never saved settings receives launchApproval.recipientThreshold: null.
Team keys require campaigns:read. Project tokens are not accepted.
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 1 child field
Show 3 headers
400A path, query, or request-body value did not pass validation.
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
curl "https://api.polymorfa.com/platform/campaign-settings" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": {
"launchApproval": {
"recipientThreshold": 1
}
}
}Get campaign frequency cap
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Returns the team's contact frequency cap: the most campaign messages one phone number receives from the team in any rolling 24 hours and any rolling 7 days. Every campaign message counts, first messages and later messages of a sequence, from every campaign, project and number in the team. Test sends and messages sent outside campaigns do not count. null means no limit for that window. A team that never saved a cap receives both limits null and revision 0. A campaign can set its own, stricter cap with frequencyCap. Accepts a team API key or a live signed-in team member.
Team keys require campaigns:read. Project tokens are not accepted.
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 5 child fields
Show 3 headers
400A path, query, or request-body value did not pass validation.
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
curl "https://api.polymorfa.com/platform/campaign-settings/frequency-cap" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": {
"teamId": "00000000-0000-4000-8000-000000000000",
"maxPer24Hours": 1,
"maxPer7Days": 1,
"revision": 0,
"updatedAt": 0
}
}Update campaign frequency cap
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Replaces the team's contact frequency cap using the revision you read; a changed revision answers 409. Send null for a window to remove its limit, or both null to remove the cap. Setting a limit requires the contact frequency caps beta and otherwise answers 403 feature_unavailable; removing the cap does not. Requires a team API key or a signed-in team owner or admin; project tokens answer 403. A message over the cap is skipped with frequency_cap_exceeded; a later sequence message stops that recipient's remaining sequence. Settled skips are never retried when a cap changes.
Team keys require campaigns:manage. Project tokens are not accepted.
Body
maxPer24Hoursintegerrequirednullablerange1–50Most campaign messages one phone number receives from the team in any rolling 24 hours, 1 to 50.
nullsets no 24-hour limit.maxPer7Daysintegerrequirednullablerange1–200Most campaign messages one phone number receives from the team in any rolling 7 days, 1 to 200.
nullsets no 7-day limit. Must not be lower thanmaxPer24Hours.revisionintegerrequiredrange0–2147483646The
revisionfrom your last read.
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 5 child fields
Show 3 headers
400A path, query, or request-body value did not pass validation.
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
409The request conflicts with the resource's current state.
curl -X PUT "https://api.polymorfa.com/platform/campaign-settings/frequency-cap" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"maxPer24Hours": 1,
"maxPer7Days": 1,
"revision": 0
}'{
"data": {
"teamId": "00000000-0000-4000-8000-000000000000",
"maxPer24Hours": 1,
"maxPer7Days": 1,
"revision": 0,
"updatedAt": 0
}
}