Campaigns
A campaign returned by Platform list, get, create and update. sendWindow is null when sending is unrestricted by local hours.
The campaign object
Attributes
idstring (uuid)requiredIdentifier for this resource.
namestringrequiredHuman-readable name for this resource.
statusstringrequiredCurrent status of this resource or operation.
templateIdstring (uuid)requirednullableIdentifier of the message template.
recipientListIdstring (uuid)requirednullableIdentifier for the recipient list.
recipientCountintegerrequiredmin0Number of recipients.
sentCountintegerrequiredmin0Number of sents.
deliveredCountintegerrequiredmin0Number of delivereds.
readCountintegerrequiredmin0Number of reads.
failedCountintegerrequiredmin0Number of faileds.
skippedCountintegerrequiredmin0Number of skippeds.
scheduledAtintegerrequirednullableScheduled start in Unix milliseconds.
launchedAtintegerrequirednullableLaunch time in Unix milliseconds.
completedAtintegerrequirednullableCompletion time in Unix milliseconds.
createdAtintegerrequiredCreation time in Unix milliseconds.
updatedAtintegerrequiredLast update in Unix milliseconds.
sendWindowobjectrequirednullableSpecifies send window for this management platform campaign.
Show 5 child fields
trackedLinksarray of objectrequiredTracked links the messages reference as
{{link:<key>}}. Empty when the campaign tracks none.Show 2 child fields
variableMappingobjectnullablemax properties50How each content variable is filled; null when the campaign has no mapping.
dripobjectrequirednullableSpecifies drip for this management platform campaign.
Show 3 child fields
enrollmentOpenbooleanrequirednullableWhether the drip is configured for continuous enrollment. Null for a non-drip. Enrollment also requires running or paused status.
pauseReasonstringrequirednullableCurrent stored pause reason while paused; null when unavailable, for a manual pause without a reason, or for any other status.
followUpobjectrequirednullableSpecifies follow up for this management platform campaign.
Show 3 child fields
composerBlueprintanySpecifies composer blueprint for this management platform campaign.
messagesanySpecifies messages for this management platform campaign.
audienceRefanySpecifies audience ref for this management platform campaign.
senderConfiganySpecifies sender config for this management platform campaign.
complianceConfiganySpecifies compliance config for this management platform campaign.
variantsarray of objectnullableThe A/B variants; null for a broadcast.
Show 4 child fields
variantStrategyobjectnullableHow the A/B test runs; null for a broadcast.
Show 5 child fields
experimentOutcomeobjectrequirednullableThe saved A/B result, or null before a decision and for a broadcast.
Show 3 child fields
messageVariationsarray of objectnullableitems2–5Weighted message alternatives, or null when the campaign sends one message.
Show 3 child fields
segmentIdstring (uuid)nullableSaved audience segment the campaign evaluates at launch, or null.
segmentSnapshotobjectnullableWhat launch froze from the segment: its revision, the evaluation time in Unix milliseconds and the matching profile count. Null before a segment launch.
Show 3 child fields
frequencyCapobjectrequirednullableThis campaign's own contact frequency cap; null when only the team cap applies.
Show 2 child fields
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"status": "string",
"templateId": "00000000-0000-4000-8000-000000000000",
"recipientListId": "00000000-0000-4000-8000-000000000000",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"scheduledAt": 0,
"launchedAt": 0,
"completedAt": 0,
"createdAt": 0,
"updatedAt": 0,
"sendWindow": {
"timeZone": "string",
"days": [
"monday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
],
"recipientTimeZone": true,
"timeZoneVariable": "string"
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"variableMapping": {},
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": false
},
"enrollmentOpen": true,
"pauseReason": "string",
"followUp": {
"delaySeconds": 86400,
"expirySeconds": 604800,
"message": {
"type": "text",
"text": "string"
}
},
"composerBlueprint": null,
"messages": null,
"audienceRef": null,
"senderConfig": null,
"complianceConfig": null,
"variants": [
{
"key": "a",
"label": "string",
"weight": 1,
"blueprint": {
"version": 2,
"source": "string"
}
}
],
"variantStrategy": {
"winnerCriterion": "delivery",
"holdoutPercent": 0,
"testSlicePercent": 20,
"autoPromote": true,
"testWindowMinutes": 15
},
"experimentOutcome": {
"state": "promoted",
"winnerKey": "string",
"reason": "insufficient_evidence"
},
"messageVariations": [
{
"key": "string",
"weight": 1,
"blueprint": {
"version": 2,
"source": "string"
}
}
],
"segmentId": "00000000-0000-4000-8000-000000000000",
"segmentSnapshot": {
"revision": 1,
"evaluatedAt": 0,
"matchedCount": 0
},
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
}
}The Messaging API campaign object
Attributes
idstringrequiredIdentifier for this resource.
namestringrequiredHuman-readable name for this resource.
statusstringrequiredCurrent status of this resource or operation.
templateIdstringrequirednullableTemplate the campaign sends. When set, the template replaces composed messages.
variableMappingobjectnullablemax properties50How each
{{variable}}in the campaign's template or composed messages is filled, keyed by the variable name used in the content. At most 50 entries. A variable is filled from the recipient's value, thenfallback, then an inline{{name | fallback}}written in a composed message. A recipient with none of them is refused at launch (campaign_variables_missing) or, when launched withskipMissingVariables, skipped withmissing_variable. Null when the campaign has no mapping.messageVariationsarray of objectnullableWeighted message alternatives, or null when the campaign sends one message.
Show 3 child fields
recipientListIdstringrequirednullableIdentifier for the recipient list.
recipientCountnumberrequiredNumber of recipients.
sentCountnumberrequiredNumber of sents.
deliveredCountnumberrequiredNumber of delivereds.
readCountnumberrequiredNumber of reads.
failedCountnumberrequiredNumber of faileds.
skippedCountnumberrequiredNumber of skippeds.
scheduledAtnumberrequirednullableUnix timestamp in milliseconds when this operation is scheduled to start.
launchedAtnumberrequirednullableUnix timestamp in milliseconds when this campaign launched.
completedAtnumberrequirednullableUnix timestamp in milliseconds when this operation completed.
createdAtnumberrequiredUnix timestamp in milliseconds when this resource was created.
updatedAtnumberrequiredUnix timestamp in milliseconds when this resource was last updated.
variantsarray of objectnullableThe A/B variants; null for a broadcast.
Show 4 child fields
variantStrategyobjectnullableSpecifies variant strategy for this native campaign.
Show 5 child fields
experimentOutcomeobjectrequirednullableSpecifies experiment outcome for this native campaign.
Show 3 child fields
followUpobjectrequirednullableOne optional follow-up, sent from the Number that sent the first message. Null when the campaign has none. Content and timing freeze at launch.
Show 3 child fields
sendWindowobjectrequirednullableSpecifies send window for this native campaign.
Show 5 child fields
trackedLinksarray of objectrequiredTracked links the messages reference as
{{link:<key>}}. Empty when the campaign tracks none.Show 2 child fields
dripobjectrequirednullableSpecifies drip for this native campaign.
Show 3 child fields
enrollmentOpenbooleanrequirednullableWhether the drip is configured for continuous enrollment. Null for a non-drip. Enrollment also requires running or paused status.
pauseReasonstringrequirednullableCurrent stored pause reason while paused; null when unavailable, for a manual pause without a reason, or for any other status.
segmentIdstringnullableSaved audience segment the campaign evaluates at launch, or null. Segments are chosen with a team API key through the Platform API; this field is read-only here.
segmentSnapshotobjectnullableThe segment revision, evaluation time (Unix milliseconds) and matching profile count launch froze; null before a segment launch.
Show 3 child fields
frequencyCapobjectrequirednullableSpecifies frequency cap for this native campaign.
Show 2 child fields
{
"id": "string",
"name": "string",
"status": "string",
"templateId": "string",
"variableMapping": {},
"messageVariations": [
{
"key": "short",
"weight": 50,
"blueprint": {
"version": 0,
"source": "string"
}
}
],
"recipientListId": "string",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"scheduledAt": 0,
"launchedAt": 0,
"completedAt": 0,
"createdAt": 0,
"updatedAt": 0,
"variants": [
{
"key": "a",
"label": "Short intro",
"weight": 50,
"blueprint": {
"version": 0,
"source": "Hi {{first_name}}, your offer is ready."
}
}
],
"variantStrategy": {
"winnerCriterion": "delivery",
"holdoutPercent": 0,
"testSlicePercent": 20,
"autoPromote": true,
"testWindowMinutes": 15
},
"experimentOutcome": {
"state": "promoted",
"winnerKey": "string",
"reason": "insufficient_evidence"
},
"followUp": {
"delaySeconds": 86400,
"expirySeconds": 604800,
"message": {
"type": "text",
"text": "string"
}
},
"sendWindow": {
"timeZone": "America/Sao_Paulo",
"days": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
],
"recipientTimeZone": true,
"timeZoneVariable": "timeZone"
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": true
},
"enrollmentOpen": true,
"pauseReason": "string",
"segmentId": "string",
"segmentSnapshot": {
"revision": 0,
"evaluatedAt": 0,
"matchedCount": 0
},
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
}
}Send project campaign test
- Base URL
https://api.polymorfa.com
Required scopes (all): campaigns:manage · campaigns:read
Requires campaigns:manage and campaigns:read because the test can use stored recipient samples. Sends one copy of a draft campaign's content to a seed recipient, through the same rendering, sending, and BanSafe checks as a launched campaign. The seed recipient must be a number connected to your team. A test is not a campaign recipient and is not counted in the campaign's statistics or webhooks. A team can send 20 tests an hour, and at most 5 an hour to one seed recipient.
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstringrequiredIdentifier for this resource.
Headers
Idempotency-Keystringlength1–255Unique key, 1 to 255 bytes of UTF-8, that makes this write safe to retry for 1 hour. A retry with the same key, credential,
Polymorfa-Version, and request never runs the write again while its receipt is retained. Keep the first response. Exact response replay requires authorized replay data; opaque message or campaign bodies are not retained by default. An available exact replay carriesIdempotent-Replayed: true. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns422 idempotency_conflict. A retry while the original is still running returns409 idempotency_in_progress, and a retry after an unrecorded outcome returns409 idempotency_outcome_unknown. If the recorded response cannot be read, the retry returns503 idempotency_replay_unavailablewithRetry-Afterand the write still does not run again.
Body
sessionIdstring (uuid)requiredThe number to send the test from. It must be connected, on a plan that includes Campaigns, and, when the campaign selects numbers, one of them.
tostringrequiredlength1–32The seed recipient in international format. It must be the phone of a number connected to your team.
sampleRecipientIdstring (uuid)A recipient of this campaign whose variables fill the content. Without it and without
variables, the campaign's first recipient, or its audience's first member, is the sample.variablesobjectmax properties50Variable values for the test, at most 50. They override the sample recipient's values; without
sampleRecipientId, only these values are used.
Responses
200OK
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 8 child fields
Show 4 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
402`campaigns_not_entitled`: the sending number's plan does not include Campaigns.
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
409`state_conflict`: The campaign is not a draft or has A/B or weighted content alternatives, the sending number is a Hybrid Link number, or the seed recipient opted out. `bansafe_cold_held`: the seed recipient has never written to the sending number and the campaign holds first messages. The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)
422`campaign_variables_missing`: the selected sample and explicit values cannot fill a variable in the content. The Idempotency-Key was already used for a different request (`idempotency_conflict`)
429The team or seed recipient reached its test-send limit (`rate_limit_exceeded`), or BanSafe is pacing the sending number. Follow `Retry-After`.
500Internal server error
502`upstream_failure`: the send path reported that the test could not be sent.
503The test was not sent: the sending number is not connected (`session_not_ready`), test sends or the send path are unavailable (`service_unavailable`, `command_dispatch_failed`), or the sending number's allowance could not be checked (`bansafe_accounting_unavailable`). Retry later. For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend
504`result_unknown`: the outcome was not received in time. The test may still arrive.
curl -X POST "https://api.polymorfa.com/messaging/projects/<projectSlug>/campaigns/<id>/test-send" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"sessionId": "00000000-0000-4000-8000-000000000000",
"to": "+5511999990000"
}'{
"success": true,
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"campaignId": "00000000-0000-4000-8000-000000000000",
"status": "sent",
"from": {
"sessionId": "00000000-0000-4000-8000-000000000000",
"phone": "string"
},
"to": "string",
"messageId": "string",
"variables": {},
"createdAt": 0
}
}Create project campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Creates a draft campaign on any plan. senderConfig.sessionIds may name numbers that are not yet on a plan that includes Campaigns; launch checks the selection. It is refused with 403 bansafe_team_suspended while the team is suspended and 400 when senderConfig.sessionIds is malformed or a per-number cap is above its safety ceiling.
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
Headers
Idempotency-Keystringlength1–255Unique key, 1 to 255 bytes of UTF-8, that makes this write safe to retry for 1 hour. A retry with the same key, credential,
Polymorfa-Version, and request never runs the write again while its receipt is retained. Keep the first response. Exact response replay requires authorized replay data; opaque message or campaign bodies are not retained by default. An available exact replay carriesIdempotent-Replayed: true. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns422 idempotency_conflict. A retry while the original is still running returns409 idempotency_in_progress, and a retry after an unrecorded outcome returns409 idempotency_outcome_unknown. If the recorded response cannot be read, the retry returns503 idempotency_replay_unavailablewithRetry-Afterand the write still does not run again.
Body
namestringrequiredmin length1Human-readable name for this resource.
templateIdstring (uuid)Template in this project to send instead of composed messages. On Cloud API numbers it must be approved by WhatsApp on every number the campaign can send from before launch.
variableMappingobjectmax properties50Specifies variable mapping for this native create campaign request.
variantsarray of objectnullableitems2–4Two to four messages to test. Requires
variantStrategyand cannot be combined withtemplateId. A/B tests are a beta; a team that is not enrolled gets403 feature_unavailable. Omit, or send null with a nullvariantStrategy, for a broadcast.Show 4 child fields
variantStrategyobjectnullableSpecifies variant strategy for this native create campaign request.
Show 5 child fields
messageVariationsarray of objectnullableitems2–5Two to five message alternatives for linked-device numbers. Each recipient receives one, chosen by weight, and keeps it across retries. Cannot be combined with composed messages, a template or an A/B test. A beta; a team that is not enrolled gets
403 feature_unavailable.Show 3 child fields
recipientListIdstringIdentifier for the recipient list.
senderConfigobjectStructured sender config values for this native create campaign request.
scheduledAtnumberUnix timestamp in milliseconds when this operation is scheduled to start.
sendWindowobjectnullableSpecifies send window for this native create campaign request.
Show 5 child fields
dripobjectnullableSpecifies drip for this native create campaign request.
Show 3 child fields
trackedLinksarray of objectnullablemax items5Beta. Links to track, at most 5. Each message reference
{{link:<key>}}is replaced with a short link per recipient that redirects tourl. Only campaigns sent from linked-device numbers track links. Setting links requires the campaign link tracking beta (403 feature_unavailableotherwise);nullor[]removes them.Show 2 child fields
frequencyCapobjectnullableSpecifies frequency cap for this native create campaign request.
Show 2 child fields
followUpobjectnullableOne optional follow-up. A beta; a team that is not enrolled gets
403 feature_unavailable. Requires a single first message: a campaign with a composed message sequence cannot launch with a follow-up. Follow-up text cannot contain tracked links.Show 3 child fields
recipientsarray of objectmax items1000Recipients to add inline, at most 1,000. Every entry must be valid or the campaign is not created; a repeated phone is kept once. Combine with
recipientListIdto add an audience at launch; add more with the add-recipients endpoint while the campaign is a draft.Show 2 child fields
Responses
200OK
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 30 child fields
Show 4 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
409The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)
422The Idempotency-Key was already used for a different request (`idempotency_conflict`)
500Internal server error
503For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend
curl -X POST "https://api.polymorfa.com/messaging/projects/<projectSlug>/campaigns" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"name": "string"
}'{
"success": true,
"data": {
"id": "string",
"name": "string",
"status": "string",
"templateId": "string",
"recipientListId": "string",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"scheduledAt": 0,
"launchedAt": 0,
"completedAt": 0,
"createdAt": 0,
"updatedAt": 0,
"experimentOutcome": {
"state": "promoted"
},
"followUp": {
"message": {
"type": "text",
"text": "string"
}
},
"sendWindow": {
"timeZone": "America/Sao_Paulo",
"days": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
],
"recipientTimeZone": true,
"timeZoneVariable": "timeZone"
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": true
},
"enrollmentOpen": true,
"pauseReason": "string",
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
}
}
}Create project campaign reply flow
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Creates an immutable reply flow revision: the steps a campaign runs when a recipient replies. Each step can send a text, reply buttons, a list, or a Flow form, and branches on the button or list row chosen, an exact keyword, or a Flow form submission. Beta.
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
Body
namestringrequiredlength1–128Human-readable name for this resource.
flowKeystring (uuid)Existing flow key to add a revision to. Omit to start a new reply flow.
revisionintegerrange1–1000000Revision number. Defaults to 1; each key and revision can be created once.
definitionobjectrequiredStructured definition for this resource.
Show 2 child fields
Responses
200OK
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
403`missing_scope`, or `feature_unavailable` when campaign reply flows are not enabled for the team.
404Resource not found
409`state_conflict`: this flow key and revision already exist.
500Internal server error
curl -X POST "https://api.polymorfa.com/messaging/projects/<projectSlug>/campaign-reply-flows" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"definition": {
"entryNodeId": "string",
"nodes": [
{
"id": "string",
"edges": [
{
"match": null,
"to": "string"
}
]
}
]
}
}'{
"success": true,
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"flowKey": "00000000-0000-4000-8000-000000000000",
"revision": 0,
"name": "string",
"definition": {
"entryNodeId": "string",
"nodes": [
{
"id": "string",
"edges": [
{
"match": null,
"to": null
}
]
}
]
},
"createdAt": 0
}
}Create campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Creates a draft campaign on any plan. messagesArray holds up to 10 composed messages, with each delayAfterSec from 0 to 86400, or 2592000 for a drip. drip requires the default-off drip sequences beta (403 feature_unavailable). Only an unlaunched draft can change drip settings, except a running or paused continuous drip can close enrollment by setting enrollment to audience with the same exit settings. senderConfig.sessionIds may name numbers that are not yet on a plan that includes Campaigns; launch checks the selection. templateId must name a template in the campaign's project, and a malformed variableMapping answers 400 invalid_parameter naming the field. It is refused with 403 bansafe_team_suspended while the team is suspended, 400 invalid_parameter when senderConfig.sessionIds is malformed, and 400 campaign_throughput_capped when a per-number cap is above its safety ceiling. Setting trackedLinks requires the campaign link tracking beta and otherwise answers 403 feature_unavailable. variants and variantStrategy make an A/B test, a beta: without enrollment it answers 403 feature_unavailable, and a template with variants answers 400 invalid_parameter.
Requires campaigns:manage. Project tokens only access resources in their own project.
Body
namestringrequiredlength1–200Campaign name, trimmed before validation. Must not be blank.
projectIdstring (uuid)Required when using a team API key. Project tokens derive the project from the credential.
templateIdstring (uuid)Template in the campaign's project to send instead of composed messages. On Cloud API numbers it must be approved by WhatsApp before launch.
variableMappingobjectmax properties50Specifies variable mapping for this management create platform campaign request.
recipientListIdstring (uuid)Audience in the same team whose members are copied when the campaign launches.
segmentIdstring (uuid)Beta. Saved audience segment evaluated once when the campaign launches; the matching profiles become its recipients. Cannot be combined with
recipientListId. Requires a team API key or the dashboard and the audience segments beta.senderConfigobjectStructured sender config values for this management create platform campaign request.
scheduledAtnumberScheduled start time in Unix milliseconds.
sendWindowobjectnullableSpecifies send window for this management create platform campaign request.
Show 5 child fields
trackedLinksarray of objectnullablemax items5Beta. Links to track, at most 5. Each message reference
{{link:<key>}}is replaced with a short link per recipient that redirects tourl. Only campaigns sent from linked-device numbers track links.nullor[]stores none.Show 2 child fields
dripobjectnullableBeta access is required. Defaults to audience enrollment, exit on reply true and exit on link open false. Null creates an ordinary campaign.
Show 3 child fields
frequencyCapobjectnullableBeta. This campaign's own contact frequency cap, counted over every campaign message the team sent to the phone number. Each limit applies together with the team cap and the lower one wins, so a campaign cap can only make sending stricter. A message over a limit is skipped with
frequency_cap_exceeded; later sequence messages stop for that recipient.nulluses the team cap alone. Setting a cap requires the contact frequency caps beta and otherwise answers403 feature_unavailable.Show 2 child fields
followUpobjectnullableSpecifies follow up for this management create platform campaign request.
Show 3 child fields
recipientsarray of objectitems0–1000At most 1,000 recipients per request.
Show 2 child fields
recipientCountnumberIgnored when inline recipients are provided; their stored count is authoritative.
composerBlueprintanySpecifies composer blueprint for this management create platform campaign request.
messagesArrayarray of objectmax items10The messages each recipient receives, in order, when the campaign has no
templateId. With a template, the template is the only message. A message with no text, media, link or call button, footer or Flow form is not sent.Show 8 child fields
audienceRefanySpecifies audience ref for this management create platform campaign request.
complianceConfiganySpecifies compliance config for this management create platform campaign request.
variantsarray of objectitems2–4Two to four messages to test. Requires
variantStrategyand cannot be combined withtemplateId. A/B tests are a beta; a team that is not enrolled gets403 feature_unavailable.Show 4 child fields
variantStrategyobjectSpecifies variant strategy for this management create platform campaign request.
Show 5 child fields
messageVariationsarray of objectitems2–5Two to five message alternatives for linked-device numbers. Each recipient receives one, chosen by weight, and keeps it across retries. Cannot be combined with composed messages, a template or an A/B test. A beta; a team that is not enrolled gets
403 feature_unavailable.Show 3 child fields
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 35 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.
404The requested resource was not found inside the authenticated team or project scope.
curl -X POST "https://api.polymorfa.com/platform/campaigns" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"name": "string"
}'{
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"status": "string",
"templateId": "00000000-0000-4000-8000-000000000000",
"recipientListId": "00000000-0000-4000-8000-000000000000",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"scheduledAt": 0,
"launchedAt": 0,
"completedAt": 0,
"createdAt": 0,
"updatedAt": 0,
"sendWindow": {
"timeZone": "string",
"days": [
"monday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
],
"recipientTimeZone": true,
"timeZoneVariable": "string"
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": false
},
"enrollmentOpen": true,
"pauseReason": "string",
"followUp": {
"message": {
"type": "text",
"text": "string"
}
},
"experimentOutcome": {
"state": "promoted"
},
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
}
}
}Create campaign reply flow
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Creates an immutable reply flow revision: the steps a campaign runs when a recipient replies. Each step can send a text, reply buttons, a list, or a Flow form (Official numbers only), and branches on the button or list row chosen, an exact keyword, or a Flow form submission. Beta: returns 403 unless campaign reply flows are enabled for the team. 409 means this flow key and revision already exist.
Requires campaigns:manage. Project tokens only access resources in their own project.
Body
namestringrequiredlength1–128Human-readable name for this resource.
flowKeystring (uuid)Existing flow key to add a revision to. Omit to start a new reply flow.
revisionintegerrange1–1000000Defaults to 1; each key and revision can be created once.
definitionobjectrequiredStructured definition for this resource.
Show 2 child fields
projectIdstring (uuid)Required when using a team API key. Project tokens derive the project from the credential.
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 6 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.
404The requested resource was not found inside the authenticated team or project scope.
409The request conflicts with the resource's current state.
curl -X POST "https://api.polymorfa.com/platform/campaign-reply-flows" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"definition": {
"entryNodeId": "string",
"nodes": [
{
"id": "string",
"edges": [
{
"match": {
"kind": "choice"
},
"to": "string"
}
]
}
]
}
}'{
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"flowKey": "00000000-0000-4000-8000-000000000000",
"revision": 0,
"name": "string",
"definition": {
"entryNodeId": "string",
"nodes": [
{
"id": "string",
"edges": [
{
"match": null,
"to": null
}
]
}
]
},
"createdAt": 0
}
}List project campaigns
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
Responses
200OK
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataarray of objectrequiredStructured data carried by this object.
Show 30 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/<projectSlug>/campaigns" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": [
{
"id": "string",
"name": "string",
"status": "string",
"templateId": "string",
"recipientListId": "string",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"scheduledAt": 0,
"launchedAt": 0,
"completedAt": 0,
"createdAt": 0,
"updatedAt": 0,
"experimentOutcome": {
"state": "promoted"
},
"followUp": {
"message": {
"type": "text",
"text": "string"
}
},
"sendWindow": {
"timeZone": "America/Sao_Paulo",
"days": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
],
"recipientTimeZone": true,
"timeZoneVariable": "timeZone"
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": true
},
"enrollmentOpen": true,
"pauseReason": "string",
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
}
}
]
}List project campaign recipients
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Lists a campaign's recipients in queue order with cursor pagination. Filter by status, by reason, or both: for example status=skipped&reason=opted_out lists recipients skipped because they opted out. failureReason gives the stable reason a recipient was not sent.
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstringrequiredIdentifier for this resource.
Query parameters
statusstringCurrent status of this resource or operation.
Allowed valuesqueuedsendingsentdeliveredreadfailedskippedreasonstringReason for the reported state or outcome.
Allowed valuesopted_outcold_heldcampaign_cancelledinvalid_recipientsession_not_connectedack_timeoutblocked_by_safetysend_failedmissing_variablefrequency_capothercursorstringmax length256Specifies cursor for this query parameter.
limitintegerrange1–100Specifies limit for this query parameter.
Responses
200OK
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataarray of objectrequiredStructured data carried by this object.
Show 19 child fields
pageobjectrequiredSpecifies page for this native list campaign recipients response.
Show 2 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/<projectSlug>/campaigns/<id>/recipients" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": [
{
"id": "string",
"phone": "string",
"variables": {},
"variantKey": "string",
"status": "queued",
"attempts": 0,
"lastError": "string",
"failureReason": "opted_out",
"externalMessageId": "string",
"queuedAt": 0,
"sentAt": 0,
"deliveredAt": 0,
"readAt": 0,
"failedAt": 0,
"respondedAt": 0,
"messagesSent": 0,
"nextMessageAt": 0,
"sequenceError": "string",
"followUp": {
"id": "00000000-0000-4000-8000-000000000000",
"numberId": "00000000-0000-4000-8000-000000000000",
"status": "waiting_receipt",
"anchorKind": "delivered",
"firstDeliveredAt": 0,
"firstReadAt": 0,
"dueAt": 0,
"expiresAt": 0,
"sentAt": 0,
"deliveredAt": 0,
"readAt": 0,
"repliedAt": 0,
"reason": "string",
"commandId": "00000000-0000-4000-8000-000000000000"
}
}
],
"page": {
"nextCursor": "string",
"hasMore": true
}
}List campaigns
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Lists campaigns in the selected project, including each campaign's stored send window and delivery counts.
Requires campaigns:read. Project tokens only access resources in their own project.
Query parameters
projectIdstringrequiredIdentifier of the Polymorfa project that owns this resource.
projectSlugstringSpecifies project slug for this query parameter.
Responses
200Success
dataarray of objectrequiredStructured data carried by this object.
Show 35 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.
404The requested resource was not found inside the authenticated team or project scope.
curl "https://api.polymorfa.com/platform/campaigns?projectId=<projectId>" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": [
{
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"status": "string",
"templateId": "00000000-0000-4000-8000-000000000000",
"recipientListId": "00000000-0000-4000-8000-000000000000",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"scheduledAt": 0,
"launchedAt": 0,
"completedAt": 0,
"createdAt": 0,
"updatedAt": 0,
"sendWindow": {
"timeZone": "string",
"days": [
"monday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
],
"recipientTimeZone": true,
"timeZoneVariable": "string"
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": false
},
"enrollmentOpen": true,
"pauseReason": "string",
"followUp": {
"message": {
"type": "text",
"text": "string"
}
},
"experimentOutcome": {
"state": "promoted"
},
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
}
}
]
}List campaign events
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Public Management API. Requires campaigns:read. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Query parameters
projectIdstringProject the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it.
Responses
200Success
dataanyrequiredOperation result.
Show 3 headers
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
curl "https://api.polymorfa.com/platform/campaigns/<campaignId>/events" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": null
}List campaign recipients
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Lists a campaign's recipients in queue order with cursor pagination. Filter by status, by reason, or both: for example status=skipped&reason=opted_out lists recipients skipped because the number opted out. failureReason gives the stable reason a recipient was not sent.
Requires campaigns:read. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Query parameters
projectIdstring (uuid)Project the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it.
statusstringCurrent status of this resource or operation.
Allowed valuesqueuedsendingsentdeliveredreadfailedskippedreasonstringOnly recipients whose
failureReasonis this code.Allowed valuesopted_outcold_heldcampaign_cancelledinvalid_recipientsession_not_connectedack_timeoutblocked_by_safetysend_failedmissing_variablefrequency_capothercursorstringlength1–256Specifies cursor for this query parameter.
limitintegerrange1–100Specifies limit for this query parameter.
Default25
Responses
200Success
dataarray of objectrequiredStructured data carried by this object.
Show 19 child fields
pageobjectrequiredSpecifies page for this schema.
Show 2 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.
404The requested resource was not found inside the authenticated team or project scope.
curl "https://api.polymorfa.com/platform/campaigns/<campaignId>/recipients" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": [
{
"id": "00000000-0000-4000-8000-000000000000",
"phone": "string",
"variables": {},
"variantKey": "string",
"status": "queued",
"attempts": 0,
"lastError": "string",
"failureReason": "opted_out",
"externalMessageId": "string",
"queuedAt": 0,
"sentAt": 0,
"deliveredAt": 0,
"readAt": 0,
"failedAt": 0,
"respondedAt": 0,
"messagesSent": 0,
"nextMessageAt": 0,
"sequenceError": "string",
"followUp": {
"id": "00000000-0000-4000-8000-000000000000",
"numberId": "00000000-0000-4000-8000-000000000000",
"status": "waiting_receipt",
"anchorKind": "delivered",
"firstDeliveredAt": 0,
"firstReadAt": 0,
"dueAt": 0,
"sentAt": 0,
"deliveredAt": 0,
"readAt": 0,
"repliedAt": 0,
"expiresAt": 0,
"reason": "string",
"commandId": "00000000-0000-4000-8000-000000000000"
}
}
],
"page": {
"nextCursor": "string",
"hasMore": true
}
}List campaign launch approvals
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Lists a campaign's approval requests, newest first, at most 20. A request is created when a launch is held by the team's approval threshold, or when an AI agent asks through the hosted MCP server to launch, resume or move the start (reasons says which). action is the requested step. It records the frozen recipient count and the requested start time. status is pending until a team owner or admin approves or rejects it, superseded when a later launch request or a change to the campaign replaced it, and expired 72 hours after it was requested.
Requires campaigns:read. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Query parameters
projectIdstringProject the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it.
Responses
200Success
dataarray of objectrequiredStructured data carried by this object.
Show 13 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.
404The requested resource was not found inside the authenticated team or project scope.
curl "https://api.polymorfa.com/platform/campaigns/<campaignId>/approvals" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": [
{
"id": "00000000-0000-4000-8000-000000000000",
"campaignId": "00000000-0000-4000-8000-000000000000",
"action": "launch",
"status": "pending",
"reasons": [
"audience_threshold"
],
"recipientCount": 0,
"scheduledAt": 0,
"requestedBy": {
"type": "string",
"id": "string"
},
"requestedAt": 0,
"expiresAt": 0,
"decidedBy": "string",
"decidedAt": 0,
"operationId": "00000000-0000-4000-8000-000000000000"
}
]
}Get project campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstringrequiredIdentifier for this resource.
Responses
200OK
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 30 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/<projectSlug>/campaigns/<id>" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": {
"id": "string",
"name": "string",
"status": "string",
"templateId": "string",
"recipientListId": "string",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"scheduledAt": 0,
"launchedAt": 0,
"completedAt": 0,
"createdAt": 0,
"updatedAt": 0,
"experimentOutcome": {
"state": "promoted"
},
"followUp": {
"message": {
"type": "text",
"text": "string"
}
},
"sendWindow": {
"timeZone": "America/Sao_Paulo",
"days": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
],
"recipientTimeZone": true,
"timeZoneVariable": "timeZone"
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": true
},
"enrollmentOpen": true,
"pauseReason": "string",
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
}
}
}Get project campaign analytics
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstringrequiredIdentifier for this resource.
Responses
200OK
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 16 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/<projectSlug>/campaigns/<id>/analytics" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": {
"campaignId": "string",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"respondedCount": 0,
"responseRate": 0,
"averageResponseTimeMs": 0,
"minResponseTimeMs": 0,
"maxResponseTimeMs": 0,
"experiment": {
"criterion": "delivery",
"outcome": {
"state": "promoted"
},
"holdoutCount": 0,
"reserveCount": 0,
"variants": [
{
"key": "string",
"label": "string",
"weight": 0,
"assigned": 0,
"sent": 0,
"delivered": 0,
"read": 0,
"replied": 0,
"outcomeRate": 0
}
]
},
"drip": {
"enrollment": "audience",
"enrolled": 0,
"enrolledByApi": 0,
"active": 0,
"completed": 0,
"exited": 0,
"steps": [
{
"step": 0,
"entered": 0,
"waiting": 0,
"sent": 0,
"delivered": 0,
"read": 0,
"replied": 0,
"exited": 0,
"failed": 0
}
]
},
"frequencyCap": {
"skippedRecipientCount": 0
},
"followUps": {
"total": 0,
"waiting": 0,
"scheduled": 0,
"sending": 0,
"sent": 0,
"delivered": 0,
"read": 0,
"replied": 0,
"cancelled": 0,
"expired": 0,
"failed": 0,
"unknown": 0,
"nextDueAt": 0
}
}
}Get project campaign links
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Beta. Opens of each tracked link, in the campaign's link order. An open is a request to the short link: a person, or an app or security scanner previewing the link. It is not proof of a click. Requires the campaign link tracking beta (403 feature_unavailable otherwise).
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstringrequiredIdentifier for this resource.
Responses
200OK
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataarray of objectrequiredStructured data carried by this object.
Show 4 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/<projectSlug>/campaigns/<id>/links" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": [
{
"key": "offer",
"url": "https://example.com/spring-sale",
"uniqueOpens": 0,
"totalOpens": 0
}
]
}Get project campaign reply flow
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstring (uuid)requiredIdentifier for this resource.
Responses
200OK
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
403`missing_scope`, or `feature_unavailable` when campaign reply flows are not enabled for the team.
404Resource not found
500Internal server error
curl "https://api.polymorfa.com/messaging/projects/<projectSlug>/campaign-reply-flows/<id>" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"flowKey": "00000000-0000-4000-8000-000000000000",
"revision": 0,
"name": "string",
"definition": {
"entryNodeId": "string",
"nodes": [
{
"id": "string",
"edges": [
{
"match": null,
"to": null
}
]
}
]
},
"createdAt": 0
}
}Get campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Returns one campaign and its stored send window, or null when no matching campaign exists in the selected project.
Requires campaigns:read. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Query parameters
projectIdstringProject the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it.
Responses
200Success
dataobjectrequirednullableStructured data carried by this object.
Show 35 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.
404The requested resource was not found inside the authenticated team or project scope.
curl "https://api.polymorfa.com/platform/campaigns/<campaignId>" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"status": "string",
"templateId": "00000000-0000-4000-8000-000000000000",
"recipientListId": "00000000-0000-4000-8000-000000000000",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"scheduledAt": 0,
"launchedAt": 0,
"completedAt": 0,
"createdAt": 0,
"updatedAt": 0,
"sendWindow": {
"timeZone": "string",
"days": [
"monday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
],
"recipientTimeZone": true,
"timeZoneVariable": "string"
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": false
},
"enrollmentOpen": true,
"pauseReason": "string",
"followUp": {
"message": {
"type": "text",
"text": "string"
}
},
"experimentOutcome": {
"state": "promoted"
},
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
}
}
}Get campaign reply flow
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Gets one reply flow revision in a project. Beta: returns 403 unless campaign reply flows are enabled for the team.
Requires campaigns:read. Project tokens only access resources in their own project.
Path parameters
replyFlowIdstringrequiredIdentifier for the reply flow.
Query parameters
projectIdstringIdentifier of the Polymorfa project that owns this resource.
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 6 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.
404The requested resource was not found inside the authenticated team or project scope.
curl "https://api.polymorfa.com/platform/campaign-reply-flows/<replyFlowId>" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"flowKey": "00000000-0000-4000-8000-000000000000",
"revision": 0,
"name": "string",
"definition": {
"entryNodeId": "string",
"nodes": [
{
"id": "string",
"edges": [
{
"match": null,
"to": null
}
]
}
]
},
"createdAt": 0
}
}Get campaign analytics
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Returns the campaign's delivery funnel, reply timing, for an A/B campaign results by variant with the saved outcome, and a separate follow-up report. Follow-up counts never change the first-message counts.
Requires campaigns:read. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Query parameters
projectIdstringProject the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it.
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 16 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.
404The requested resource was not found inside the authenticated team or project scope.
curl "https://api.polymorfa.com/platform/campaigns/<campaignId>/analytics" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": {
"campaignId": "00000000-0000-4000-8000-000000000000",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"respondedCount": 0,
"responseRate": 0,
"averageResponseTimeMs": 0,
"minResponseTimeMs": 0,
"maxResponseTimeMs": 0,
"experiment": {
"criterion": "delivery",
"outcome": {
"state": "promoted"
},
"holdoutCount": 0,
"reserveCount": 0,
"variants": [
{
"key": "string",
"label": "string",
"weight": 0,
"assigned": 0,
"sent": 0,
"delivered": 0,
"read": 0,
"replied": 0,
"outcomeRate": 0
}
]
},
"drip": {
"enrollment": "audience",
"enrolled": 0,
"enrolledByApi": 0,
"active": 0,
"completed": 0,
"exited": 0,
"steps": [
{
"step": 0,
"entered": 0,
"waiting": 0,
"sent": 0,
"delivered": 0,
"read": 0,
"replied": 0,
"exited": 0,
"failed": 0
}
]
},
"frequencyCap": {
"skippedRecipientCount": 0
},
"followUps": {
"total": 0,
"waiting": 0,
"scheduled": 0,
"sending": 0,
"sent": 0,
"delivered": 0,
"read": 0,
"replied": 0,
"cancelled": 0,
"expired": 0,
"failed": 0,
"unknown": 0,
"nextDueAt": 0
}
}
}Get campaign links
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Beta: requires team enrollment in campaign link tracking. Returns opens of each tracked link in the campaign's link order. An open is a request to the short link from a person, or from an app or security scanner previewing the link; it is not proof of a click. uniqueOpens counts recipients who opened the link at least once; totalOpens counts every open. A team without the beta answers 403 feature_unavailable.
Requires campaigns:read. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Query parameters
projectIdstringProject the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it.
Responses
200Success
dataarray of objectrequiredStructured data carried by this object.
Show 4 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.
404The requested resource was not found inside the authenticated team or project scope.
curl "https://api.polymorfa.com/platform/campaigns/<campaignId>/links" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": [
{
"key": "offer",
"url": "string",
"uniqueOpens": 0,
"totalOpens": 0
}
]
}Update project campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Updates the fields you send and leaves the rest unchanged. On an unlaunched draft, a new senderConfig passes the same checks as create, on any plan; launch checks the selection against live plans. Once the campaign has launched, including a scheduled launch that has not started, a new senderConfig must pass the launch checks and can answer 402 campaigns_not_entitled or 400 invalid_parameter. recipientListId, a different scheduledAt, and a changed templateId or variableMapping are accepted only while the campaign is an unlaunched draft; afterwards they answer 409. Sending the stored value again is not a change. trackedLinks changes only while draft, including while waiting for a scheduled start; afterwards it answers 409. A sender change to a draft that launches while the change is being saved also answers 409. sendWindow changes only while draft or paused; a paused edit answers 409 while sends are in progress. A non-null scheduledAt must be integer Unix milliseconds within the JavaScript Date range.
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstring (uuid)requiredIdentifier for this resource.
Body
namestringlength1–200New name, 1 to 200 characters after trimming.
followUpobjectnullableOne follow-up, editable only before launch. Null removes it. A beta; a team that is not enrolled gets
403 feature_unavailablewhen setting one. The first read takes precedence over the first delivery; replies and opt-outs cancel; an expired wait never sends.Show 3 child fields
recipientListIdstring (uuid)nullableAudience to send to, or null for none. Only an unlaunched draft can change it; the campaign's current recipients are replaced by the audience's members at launch.
senderConfigobjectReplaces the sender selection and throughput. On an unlaunched draft it passes the same checks as create. Once the campaign has launched it must pass the launch checks.
scheduledAtintegernullablerange0–8640000000000000Start time in milliseconds since the Unix epoch, or null to start at launch. Only an unlaunched draft can change it.
sendWindowobjectnullableSpecifies send window for this native update campaign request.
Show 5 child fields
dripobjectnullableSpecifies drip for this native update campaign request.
Show 3 child fields
frequencyCapobjectnullableSpecifies frequency cap for this native update campaign request.
Show 2 child fields
trackedLinksarray of objectnullablemax items5Beta. Links to track, at most 5. Each message reference
{{link:<key>}}is replaced with a short link per recipient that redirects tourl. Only campaigns sent from linked-device numbers track links. Setting links requires the campaign link tracking beta (403 feature_unavailableotherwise);nullor[]removes them. Only a draft, including one waiting for its scheduled start, can change them; a launched campaign must still define every link its messages reference.Show 2 child fields
templateIdstring (uuid)nullableTemplate in this project to send instead of composed messages, or null to send the composed messages. Only an unlaunched draft can change it.
variableMappingobjectnullablemax properties50Replaces the whole variable mapping; null clears it. Only an unlaunched draft can change it.
messageVariationsarray of objectnullableitems2–5Replaces the weighted message alternatives; null clears them. Only an unlaunched draft can change it.
Show 3 child fields
variantsarray of objectnullableitems2–4Replaces the A/B variants. Null, together with a null
variantStrategy, makes the draft a broadcast. Only an unlaunched draft can change it.Show 4 child fields
variantStrategyobjectnullableSpecifies variant strategy for this native update campaign request.
Show 5 child fields
Responses
200OK
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 30 child fields
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
402`campaigns_not_entitled`: a new sender selection on a launched campaign names a number whose plan does not include Campaigns
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
409`state_conflict`: the campaign has launched and the audience or start time can no longer change, it launched while its sending numbers were being changed, its send window cannot change in the current state or while sends are in progress, or its tracked links cannot change after sending started
500Internal server error
503`service_unavailable`: number eligibility for a launched campaign's new sender selection could not be checked. Nothing was changed
curl -X PATCH "https://api.polymorfa.com/messaging/projects/<projectSlug>/campaigns/<id>" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"followUp": {
"message": {
"type": "text",
"text": "string"
}
},
"recipientListId": "00000000-0000-4000-8000-000000000000",
"senderConfig": {},
"scheduledAt": 0,
"sendWindow": {
"days": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
]
},
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": true
},
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"templateId": "00000000-0000-4000-8000-000000000000",
"variableMapping": {},
"messageVariations": [
{
"key": "short",
"weight": 50,
"blueprint": {
"version": 0,
"source": "string"
}
}
],
"variants": [
{
"key": "a",
"label": "Short intro",
"weight": 50,
"blueprint": {
"version": 0,
"source": "Hi {{first_name}}, your offer is ready."
}
}
],
"variantStrategy": {
"winnerCriterion": "delivery",
"holdoutPercent": 0,
"autoPromote": true,
"testWindowMinutes": 15
}
}'{
"success": true,
"data": {
"id": "string",
"name": "string",
"status": "string",
"templateId": "string",
"recipientListId": "string",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"scheduledAt": 0,
"launchedAt": 0,
"completedAt": 0,
"createdAt": 0,
"updatedAt": 0,
"experimentOutcome": {
"state": "promoted"
},
"followUp": {
"message": {
"type": "text",
"text": "string"
}
},
"sendWindow": {
"timeZone": "America/Sao_Paulo",
"days": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
],
"recipientTimeZone": true,
"timeZoneVariable": "timeZone"
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": true
},
"enrollmentOpen": true,
"pauseReason": "string",
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
}
}
}Update campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Updates a campaign. A PATCH containing only drip that closes a running or paused continuous drip to audience enrollment with unchanged exit settings is allowed without beta access. Other non-null drip settings require the beta. messagesArray follows the same sequence rules as create. On an unlaunched draft, a new senderConfig passes the same checks as create and plans are checked at launch. Once the campaign has launched, including a scheduled launch that has not started, a new senderConfig passes the launch checks and can answer 402 campaigns_not_entitled or 400 invalid_parameter. recipientListId points the campaign at another audience while it is still an unlaunched draft and replaces its existing recipients; after launch it answers 409. templateId, variableMapping, messagesArray and composerBlueprint also change only while the campaign is an unlaunched draft; after launch a different value answers 409, and the stored value is accepted. A sender edit to a draft that launches while the edit is being saved also answers 409. A changed scheduledAt after launch answers 409; use reschedule to move a scheduled start. A non-null scheduledAt must be integer Unix milliseconds from zero through the JavaScript Date maximum. sendWindow changes only while the campaign is a draft or paused; a running campaign answers 409, so pause it first. An edit to a paused campaign also answers 409 while sends are in progress; retry after they settle. A stalled send that has not reached the provider can be recovered on a later edit attempt. If delivery may have started, the edit waits for a definite result rather than sending the recipient again. A new window applies to the remaining recipients when the campaign resumes. trackedLinks changes only while the campaign is a draft, including while it waits for a scheduled start; afterwards it answers 409. Setting tracked links requires the campaign link tracking beta and otherwise answers 403 feature_unavailable. A launched campaign must still define every {{link:<key>}} its messages reference.
Requires campaigns:manage. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Query parameters
projectIdstringProject the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it.
Body
dripobjectnullableOmitted fields preserve stored settings. Null makes the draft an ordinary campaign. Closing continuous enrollment with unchanged exit flags is allowed without beta access when it is the only change.
Show 3 child fields
namestringlength1–200Human-readable name for this resource.
projectIdstring (uuid)Required when using a team API key. Project tokens derive the project from the credential.
templateIdstring (uuid)nullableTemplate in the campaign project, or null to send composed messages. Only while the campaign is an unlaunched draft.
variableMappingobjectnullablemax properties50Replaces the whole mapping; null clears it. Only while the campaign is an unlaunched draft.
recipientListIdstring (uuid)nullableAudience to send to. Only while the campaign is an unlaunched draft. Setting an audience clears
segmentId.segmentIdstring (uuid)nullableBeta. Saved audience segment to evaluate at launch, or null to clear it. Only while the campaign is an unlaunched draft. Setting a segment clears
recipientListId; sending both answers400. Requires a team API key or the dashboard and the audience segments beta.senderConfigobjectStructured sender config values for this management update platform campaign request.
scheduledAtintegernullablerange0–8640000000000000Scheduled start time in Unix milliseconds. Only while the campaign is an unlaunched draft.
followUpobjectnullableOnly editable before launch. Null removes the optional follow-up.
Show 3 child fields
sendWindowobjectnullableWhen the campaign may send.
nullremoves the window. Only while the campaign is a draft or paused.Show 5 child fields
trackedLinksarray of objectnullablemax items5Beta. Replaces the tracked links, at most 5.
nullor[]removes them. Only while the campaign is a draft, including while it waits for a scheduled start.Show 2 child fields
frequencyCapobjectnullableBeta. Replaces this campaign's own contact frequency cap;
nullremoves it and leaves the team cap. Only while the campaign is a draft or paused; a running campaign answers409, so pause it first. Setting a cap requires the contact frequency caps beta; removing one does not.Show 2 child fields
recipientCountnumberNumber of recipients.
composerBlueprintanySpecifies composer blueprint for this management update platform campaign request.
messagesArrayarray of objectmax items10Replaces the messages each recipient receives, in order, with the same rules as create. Only while the campaign is an unlaunched draft.
Show 8 child fields
audienceRefanySpecifies audience ref for this management update platform campaign request.
complianceConfiganySpecifies compliance config for this management update platform campaign request.
variantsarray of objectnullableitems2–4Replaces the A/B variants.
null, together with a nullvariantStrategy, makes the draft a broadcast. Only while the campaign is an unlaunched draft.Show 4 child fields
variantStrategyobjectnullableReplaces how the A/B test runs. Only while the campaign is an unlaunched draft.
Show 5 child fields
messageVariationsarray of objectnullableitems2–5Replaces the weighted linked-device alternatives; null clears them. Only while the campaign is an unlaunched draft.
Show 3 child fields
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 35 child fields
Show 3 headers
400A path, query, or request-body value did not pass validation.
401Missing/invalid credential for this audience.
402`campaigns_not_entitled`: a sending number is missing or its plan does not include Campaigns.
403Authenticated but lacks the required scope/role/audience.
404The requested resource was not found inside the authenticated team or project scope.
409The request conflicts with the resource's current state.
503`service_unavailable`: the selected numbers' plans could not be checked. Nothing was launched or saved; retry the request.
curl -X PATCH "https://api.polymorfa.com/platform/campaigns/<campaignId>" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": true
},
"name": "string",
"projectId": "00000000-0000-4000-8000-000000000000",
"templateId": "00000000-0000-4000-8000-000000000000",
"variableMapping": {},
"recipientListId": "00000000-0000-4000-8000-000000000000",
"segmentId": "00000000-0000-4000-8000-000000000000",
"senderConfig": {},
"scheduledAt": 0,
"followUp": {
"message": {
"type": "text",
"text": "string"
}
},
"sendWindow": {
"days": [
"monday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
]
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
},
"recipientCount": 0,
"composerBlueprint": null,
"messagesArray": [
{
"version": 2,
"source": "string",
"media": {
"kind": "image",
"url": "https://example.com"
},
"buttons": [
{
"kind": "reply",
"label": "string"
}
],
"footer": "string",
"delayUnit": "minutes",
"sendWindow": {
"days": [
"monday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
]
},
"delayAfterSec": 0
}
],
"audienceRef": null,
"complianceConfig": null,
"variants": [
{
"key": "a",
"label": "string",
"weight": 1,
"blueprint": {
"version": 2,
"source": "string"
}
}
],
"variantStrategy": {
"winnerCriterion": "delivery",
"holdoutPercent": 0,
"autoPromote": true,
"testWindowMinutes": 15
},
"messageVariations": [
{
"key": "string",
"weight": 1,
"blueprint": {
"version": 2,
"source": "string"
}
}
]
}'{
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"status": "string",
"templateId": "00000000-0000-4000-8000-000000000000",
"recipientListId": "00000000-0000-4000-8000-000000000000",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"scheduledAt": 0,
"launchedAt": 0,
"completedAt": 0,
"createdAt": 0,
"updatedAt": 0,
"sendWindow": {
"timeZone": "string",
"days": [
"monday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
],
"recipientTimeZone": true,
"timeZoneVariable": "string"
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": false
},
"enrollmentOpen": true,
"pauseReason": "string",
"followUp": {
"message": {
"type": "text",
"text": "string"
}
},
"experimentOutcome": {
"state": "promoted"
},
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
}
}
}Enroll project campaign contact
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Beta. Adds one contact to a running or paused drip whose drip.enrollment is continuous. The contact starts at the first step, subject to the drip's send window, pacing and caps. Idempotent per phone: a phone already in the drip, including one that finished or left, returns its existing enrollment with created: false. An opted-out phone is enrolled as skipped and never sent. A team without the drip sequences beta gets 403 feature_unavailable; a campaign that is not a drip, or a drip that is not accepting enrollments, answers 409 state_conflict.
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstring (uuid)requiredIdentifier for this resource.
Body
phonestringrequiredlength1–32The contact in international format. A phone already in the drip returns its existing enrollment with
created: false.variablesobjectmax properties50The contact's variables, at most 50, used to fill the steps.
Responses
200OK
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
409`state_conflict`: the campaign is not a drip, or the drip does not use continuous enrollment, has not started, or has ended
500Internal server error
curl -X POST "https://api.polymorfa.com/messaging/projects/<projectSlug>/campaigns/<id>/enrollments" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"phone": "+5511999990000"
}'{
"success": true,
"data": {
"campaignId": "00000000-0000-4000-8000-000000000000",
"recipientId": "00000000-0000-4000-8000-000000000000",
"phone": "string",
"created": true,
"status": "string",
"enrolledAt": 0
}
}Launch project campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Starts a draft campaign. It begins sending at scheduledAt, or right away when no start time is set. Launch checks the saved sender selection against live plans: 402 campaigns_not_entitled when a selected number is missing or its plan does not include Campaigns, or when an unselected campaign's project has no such number; 400 invalid_parameter on senderConfig.sessionIds when a selected number is not connected or the selection mixes sending types; 400 campaign_throughput_capped when a requested throughput is above its ceiling. Segment campaigns require a team API key; project tokens answer 403 permission_denied, and unavailable audience betas answer 403 feature_unavailable. An audience change during launch answers 409 state_conflict. Segment evaluation that exceeds its time limit also answers 409 state_conflict; simplify the rules and retry. A launched campaign whose segment was deleted remains launched and cannot be launched again (409 state_conflict). A message that references a {{link:<key>}} the campaign does not define, or tracked links on a campaign that would send from Official API numbers, answers 400 invalid_parameter on trackedLinks; tracked links without the campaign link tracking beta answer 403 feature_unavailable. A drip without a sendable composed message answers 400 invalid_parameter on messagesArray. Saving a draft does not apply this check. The template must be complete and approved on every Cloud API number; every recipient needs a value or fallback for each variable unless skipMissingVariables is true. When the team requires approval above a recipient threshold and the launch would send to more recipients, it answers 409 campaign_approval_required, sends nothing, and records a pending approval request for a team owner or admin. Launching again with the campaign unchanged returns the same request. A launch requested by an AI agent through the hosted MCP server is held the same way, whatever the threshold. The response returns the campaign as it was when the launch was accepted.
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstringrequiredIdentifier for this resource.
Headers
Idempotency-Keystringlength1–255Unique key, 1 to 255 bytes of UTF-8, that makes this write safe to retry for 1 hour. A retry with the same key, credential,
Polymorfa-Version, and request never runs the write again while its receipt is retained. Keep the first response. Exact response replay requires authorized replay data; opaque message or campaign bodies are not retained by default. An available exact replay carriesIdempotent-Replayed: true. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns422 idempotency_conflict. A retry while the original is still running returns409 idempotency_in_progress, and a retry after an unrecorded outcome returns409 idempotency_outcome_unknown. If the recorded response cannot be read, the retry returns503 idempotency_replay_unavailablewithRetry-Afterand the write still does not run again.
Body
scheduledAtnumberUnix timestamp in milliseconds when this operation is scheduled to start.
skipMissingVariablesbooleanLaunch even when some recipients have no value and no fallback for a variable. Those recipients are skipped with
failureReasonmissing_variablebefore the first send. Without it, such a launch is refused with422 campaign_variables_missing.
Responses
200OK
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 31 child fields
Show 4 headers
400`invalid_parameter` naming the field: an unconnected or mixed sender selection (`senderConfig.sessionIds`), an incomplete or authentication template (`templateId`), a composed attachment without a public URL, or a `{{link:<key>}}` the campaign does not define or tracked links on Official API numbers (`trackedLinks`). `campaign_throughput_capped` when a requested throughput is above its ceiling; `template_not_approved` when a Cloud API number has not approved the template.
401Missing or invalid authentication token
402`campaigns_not_entitled`: a selected number is missing or its plan does not include Campaigns, or the project has no number on such a plan. Drafts are saved on every plan.
403`permission_denied`: a project token attempted to launch a segment campaign; use a team API key or signed-in dashboard session. `feature_unavailable`: either audience beta is unavailable for a segment campaign, or the campaign has tracked links and its link tracking beta is unavailable. `bansafe_team_suspended` while the team is suspended.
404Resource not found
409`campaign_approval_required`: the launch is held for a team owner or admin and nothing was sent; the message names the approval request. `state_conflict`: the campaign is not a draft, is already launched and waiting for its start time, its sending numbers or audience changed during launch, or segment evaluation exceeded its time limit (simplify the rules and retry). A launched campaign whose segment was deleted cannot be launched again. The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)
422`campaign_variables_missing`: some recipients have no value and no fallback for a variable. The message names the variables and counts the recipients. The Idempotency-Key was already used for a different request (`idempotency_conflict`)
500Internal server error
503`service_unavailable`: the selected numbers' plans could not be checked; retry. For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend
curl -X POST "https://api.polymorfa.com/messaging/projects/<projectSlug>/campaigns/<id>/launch" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"scheduledAt": 0,
"skipMissingVariables": true
}'{
"success": true,
"data": {
"id": "string",
"name": "string",
"status": "string",
"templateId": "string",
"recipientListId": "string",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"scheduledAt": 0,
"launchedAt": 0,
"completedAt": 0,
"createdAt": 0,
"updatedAt": 0,
"experimentOutcome": {
"state": "promoted"
},
"followUp": {
"message": {
"type": "text",
"text": "string"
}
},
"sendWindow": {
"timeZone": "America/Sao_Paulo",
"days": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
],
"recipientTimeZone": true,
"timeZoneVariable": "timeZone"
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": true
},
"enrollmentOpen": true,
"pauseReason": "string",
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
},
"operationId": "00000000-0000-4000-8000-000000000000"
}
}Pause project campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Pauses a running campaign. Sends already in progress can still finish.
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstringrequiredIdentifier for this resource.
Headers
Idempotency-Keystringlength1–255Unique key, 1 to 255 bytes of UTF-8, that makes this write safe to retry for 1 hour. A retry with the same key, credential,
Polymorfa-Version, and request never runs the write again while its receipt is retained. Keep the first response. Exact response replay requires authorized replay data; opaque message or campaign bodies are not retained by default. An available exact replay carriesIdempotent-Replayed: true. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns422 idempotency_conflict. A retry while the original is still running returns409 idempotency_in_progress, and a retry after an unrecorded outcome returns409 idempotency_outcome_unknown. If the recorded response cannot be read, the retry returns503 idempotency_replay_unavailablewithRetry-Afterand the write still does not run again.
Responses
200OK
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 31 child fields
Show 4 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
409`state_conflict`: The campaign is not running, or it has no active delivery run to pause. The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)
422The Idempotency-Key was already used for a different request (`idempotency_conflict`)
500Internal server error
503For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend
curl -X POST "https://api.polymorfa.com/messaging/projects/<projectSlug>/campaigns/<id>/pause" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": {
"id": "string",
"name": "string",
"status": "string",
"templateId": "string",
"recipientListId": "string",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"scheduledAt": 0,
"launchedAt": 0,
"completedAt": 0,
"createdAt": 0,
"updatedAt": 0,
"experimentOutcome": {
"state": "promoted"
},
"followUp": {
"message": {
"type": "text",
"text": "string"
}
},
"sendWindow": {
"timeZone": "America/Sao_Paulo",
"days": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
],
"recipientTimeZone": true,
"timeZoneVariable": "timeZone"
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": true
},
"enrollmentOpen": true,
"pauseReason": "string",
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
},
"operationId": "00000000-0000-4000-8000-000000000000"
}
}Resume project campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Resumes a paused campaign. Its remaining recipients are sent after the same checks as before the pause.
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstringrequiredIdentifier for this resource.
Headers
Idempotency-Keystringlength1–255Unique key, 1 to 255 bytes of UTF-8, that makes this write safe to retry for 1 hour. A retry with the same key, credential,
Polymorfa-Version, and request never runs the write again while its receipt is retained. Keep the first response. Exact response replay requires authorized replay data; opaque message or campaign bodies are not retained by default. An available exact replay carriesIdempotent-Replayed: true. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns422 idempotency_conflict. A retry while the original is still running returns409 idempotency_in_progress, and a retry after an unrecorded outcome returns409 idempotency_outcome_unknown. If the recorded response cannot be read, the retry returns503 idempotency_replay_unavailablewithRetry-Afterand the write still does not run again.
Responses
200OK
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 31 child fields
Show 4 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
409`state_conflict`: The campaign is not paused, or it has no active delivery run to resume. The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)
422The Idempotency-Key was already used for a different request (`idempotency_conflict`)
500Internal server error
503For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend
curl -X POST "https://api.polymorfa.com/messaging/projects/<projectSlug>/campaigns/<id>/resume" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": {
"id": "string",
"name": "string",
"status": "string",
"templateId": "string",
"recipientListId": "string",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"scheduledAt": 0,
"launchedAt": 0,
"completedAt": 0,
"createdAt": 0,
"updatedAt": 0,
"experimentOutcome": {
"state": "promoted"
},
"followUp": {
"message": {
"type": "text",
"text": "string"
}
},
"sendWindow": {
"timeZone": "America/Sao_Paulo",
"days": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
],
"recipientTimeZone": true,
"timeZoneVariable": "timeZone"
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": true
},
"enrollmentOpen": true,
"pauseReason": "string",
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
},
"operationId": "00000000-0000-4000-8000-000000000000"
}
}Reschedule project campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Moves the start of a launched campaign that is still waiting for it. Set scheduledAt to a later or earlier time, or to null to start now. The response returns the campaign with its new scheduledAt. Sending the current start time again changes nothing. A campaign that has started, finished, is being stopped, or was never launched is refused with 409; launch a draft with scheduledAt instead.
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstringrequiredIdentifier for this resource.
Headers
Idempotency-Keystringlength1–255Unique key, 1 to 255 bytes of UTF-8, that makes this write safe to retry for 1 hour. A retry with the same key, credential,
Polymorfa-Version, and request never runs the write again while its receipt is retained. Keep the first response. Exact response replay requires authorized replay data; opaque message or campaign bodies are not retained by default. An available exact replay carriesIdempotent-Replayed: true. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns422 idempotency_conflict. A retry while the original is still running returns409 idempotency_in_progress, and a retry after an unrecorded outcome returns409 idempotency_outcome_unknown. If the recorded response cannot be read, the retry returns503 idempotency_replay_unavailablewithRetry-Afterand the write still does not run again.
Body
scheduledAtintegerrequirednullablegreater than0max8640000000000000The new start time as a Unix timestamp in milliseconds.
null, or a time that is not in the future, starts the campaign now.
Responses
200OK
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 31 child fields
Show 4 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
409`state_conflict`: The campaign has already started, is finished or being stopped, or was never launched. The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)
422The Idempotency-Key was already used for a different request (`idempotency_conflict`)
500Internal server error
503For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend
curl -X POST "https://api.polymorfa.com/messaging/projects/<projectSlug>/campaigns/<id>/reschedule" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"scheduledAt": 0
}'{
"success": true,
"data": {
"id": "string",
"name": "string",
"status": "string",
"templateId": "string",
"recipientListId": "string",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"scheduledAt": 0,
"launchedAt": 0,
"completedAt": 0,
"createdAt": 0,
"updatedAt": 0,
"experimentOutcome": {
"state": "promoted"
},
"followUp": {
"message": {
"type": "text",
"text": "string"
}
},
"sendWindow": {
"timeZone": "America/Sao_Paulo",
"days": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
],
"recipientTimeZone": true,
"timeZoneVariable": "timeZone"
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": true
},
"enrollmentOpen": true,
"pauseReason": "string",
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
},
"operationId": "00000000-0000-4000-8000-000000000000"
}
}Requeue campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstringrequiredIdentifier for this resource.
Body
includeSkippedErrorbooleanWhether include skipped error.
Responses
200OK
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
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 -X POST "https://api.polymorfa.com/messaging/projects/<projectSlug>/campaigns/<id>/requeue" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"includeSkippedError": true
}'{
"success": true,
"data": {}
}Set project campaign reply flow
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Attaches a reply flow revision to a draft or scheduled campaign, or detaches it with null. The flow starts for each recipient once their message is sent.
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstring (uuid)requiredIdentifier for this resource.
Body
replyFlowIdstring (uuid)requirednullableReply flow revision to run after replies, or null to detach it.
Responses
200OK
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 2 child fields
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403`missing_scope`, or `feature_unavailable` when campaign reply flows are not enabled for the team.
404Resource not found
409`state_conflict`: the campaign has already launched.
500Internal server error
curl -X PUT "https://api.polymorfa.com/messaging/projects/<projectSlug>/campaigns/<id>/reply-flow" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"replyFlowId": "00000000-0000-4000-8000-000000000000"
}'{
"success": true,
"data": {
"campaignId": "00000000-0000-4000-8000-000000000000",
"replyFlowId": "00000000-0000-4000-8000-000000000000"
}
}Add project campaign recipients
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Adds up to 1,000 recipients to a campaign that has not started sending. A phone already on the campaign is skipped. Invalid entries are reported and not added.
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstringrequiredIdentifier for this resource.
Headers
Idempotency-Keystringlength1–255Optional key, 1 to 255 bytes of UTF-8, that makes this request safe to retry for 24 hours. A retry with the same key, credential,
Polymorfa-Versionand request is not applied again: it returns200withIdempotent-Replayed: trueand the replay result described for this operation. Reusing the key for a different request returns422 idempotency_conflict. A retry sent while the original is still running waits for it and then returns its result. A request that failed left no record, so retrying it with the same key runs it again. Access to the resource is checked again on every retry. A replay returns the original counts, even after the campaign has launched.
Body
recipientsarray of objectrequireditems1–1000Recipients associated with this native add campaign recipients request.
Show 2 child fields
Responses
200OK
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 6 child fields
Show 4 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
409The campaign has started sending and no longer accepts recipients
422The Idempotency-Key was already used for a different request (`idempotency_conflict`)
500Internal server error
curl -X POST "https://api.polymorfa.com/messaging/projects/<projectSlug>/campaigns/<id>/recipients" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"recipients": [
{
"phone": "string"
}
]
}'{
"success": true,
"data": {
"campaignId": "string",
"added": 0,
"recipientCount": 0,
"duplicateCount": 0,
"invalidCount": 0,
"invalidRows": [
{
"row": 1,
"reason": "missing_phone"
}
]
}
}Export project campaign recipients
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Returns recipients as CSV in queue order. Unfiltered exports page up to 1,000 recipients per request. Each page starts with a header row. When more recipients match, the Polymorfa-Next-Cursor response header carries the cursor for the next page; it is absent on the last page. Each page is read when it is requested, so a recipient appears once, with the outcome it had when its page was read. A filtered export is one atomic page of up to 1,000 recipients; larger filtered results return 409, so changing statuses cannot silently omit matches between pages. The export contains outcomes and failureReason codes only, never message content or template variables.
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstringrequiredIdentifier for this resource.
Query parameters
statusstringCurrent status of this resource or operation.
Allowed valuesqueuedsendingsentdeliveredreadfailedskippedreasonstringReason for the reported state or outcome.
Allowed valuesopted_outcold_heldcampaign_cancelledinvalid_recipientsession_not_connectedack_timeoutblocked_by_safetysend_failedmissing_variablefrequency_capothercursorstringlength1–256Specifies cursor for this query parameter.
limitintegerrange1–1000Specifies limit for this query parameter.
Responses
200One page of recipients.
Content type
text/csvShow 4 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
409More than 1,000 recipients match the filter
500Internal server error
curl "https://api.polymorfa.com/messaging/projects/<projectSlug>/campaigns/<id>/recipients/export" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"Content type text/csv
No example for this content type
Launch campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Starts a draft campaign. It begins sending at scheduledAt, or right away when no start time is set. Launch checks the stored sender selection against live plans: 402 campaigns_not_entitled when a selected number is missing or its plan does not include Campaigns, or when an unselected campaign's project has no such number; 400 invalid_parameter on senderConfig.sessionIds when a selected number is not connected or the selection mixes sending types; 400 campaign_throughput_capped when a requested throughput is above its ceiling. A segment campaign requires a team API key or signed-in dashboard session; project tokens answer 403 permission_denied. Both audience betas must be available, otherwise launch answers 403 feature_unavailable. An audience change while launch is being authorized answers 409 state_conflict. Segment evaluation that exceeds its time limit also answers 409 state_conflict; simplify the rules and retry. A launched campaign whose segment was deleted remains launched and cannot be launched again (409 state_conflict). A drip without a sendable composed message answers 400 invalid_parameter on messagesArray. Saving a draft does not apply this check. A composed attachment requires a public media.url (400 invalid_parameter). The template must be complete (400 invalid_parameter) and approved on every Cloud API number (400 template_not_approved). Every recipient needs a value or fallback for each variable (422 campaign_variables_missing); skipMissingVariables: true skips those recipients before the first send. A message that references a {{link:<key>}} the campaign does not define, or tracked links on a campaign that would send from Official API numbers, answers 400 invalid_parameter on trackedLinks; tracked links without the campaign link tracking beta answer 403 feature_unavailable. 409 means the campaign is not a draft, is already launched and waiting for its start time, or its sending numbers changed during the launch. When the team requires approval above a recipient threshold and the launch would send to more recipients, a launch by anyone other than a team owner or admin signed in to the console answers 409 campaign_approval_required, sends nothing, and records a pending approval request that GET /platform/campaigns/{campaignId}/approvals lists. Launching again with the campaign unchanged returns the same request. A launch requested by an AI agent through the hosted MCP server is held the same way, whatever the threshold.
Requires campaigns:manage. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Headers
Idempotency-Keystringlength1–255Optional unique key, 1 to 255 bytes, that makes this request safe to retry for 1 hour. A retry with the same key, credential,
Polymorfa-Versionand request never runs it again while its receipt is retained. Keep the first response. Opaque campaign bodies are not retained by default; an available authorized exact replay carriesIdempotent-Replayed: true. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns422 idempotency_conflict. A retry while the original is still running returns409 idempotency_in_progress, and a retry after an unrecorded outcome returns409 idempotency_outcome_unknown. If the recorded response cannot be read, the retry returns503 idempotency_replay_unavailablewithRetry-After; the request does not run again. Missing replay data never releases the execution fence.
Body
projectIdstring (uuid)Required when using a team API key. Project tokens derive the project from the credential.
scheduledAtnumberScheduled start time in Unix milliseconds. Defaults to the stored start time, or now.
skipMissingVariablesbooleanLaunch even when some recipients have no value and no fallback for a variable. Those recipients are skipped with
failureReasonmissing_variablebefore the first send. Without it, such a launch answers422 campaign_variables_missing.
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 3 child fields
Show 4 headers
400A path, query, or request-body value did not pass validation.
401Missing/invalid credential for this audience.
402`campaigns_not_entitled`: a sending number is missing or its plan does not include Campaigns.
403`permission_denied`: a project token attempted to launch a segment campaign; use a team API key or signed-in dashboard session. `feature_unavailable`: either audience beta is unavailable for a segment campaign, or the campaign has tracked links and its link tracking beta is unavailable. `bansafe_team_suspended` while the team is suspended.
404The requested resource was not found inside the authenticated team or project scope.
409`campaign_approval_required`: the launch is held for a team owner or admin and nothing was sent; the message names the approval request. `state_conflict`: the campaign is not a draft, is already launched and waiting for its start, its sending numbers or audience changed during launch, or segment evaluation exceeded its time limit (simplify the rules and retry). A launched campaign whose segment was deleted cannot be launched again.
422`campaign_variables_missing`: a recipient or test sample has no value or fallback for a campaign variable; nothing was sent by that request. `idempotency_conflict`: this key belongs to a different request; the earlier request is not run again and this refusal does not establish its outcome.
503`idempotency_replay_unavailable`: the recorded response cannot be read. The original request is not run again, and its execution fence remains in place. Keep the first response; do not switch keys to resend. The selected numbers' plans can also fail to be checked (`service_unavailable`), before anything is launched or saved.
curl -X POST "https://api.polymorfa.com/platform/campaigns/<campaignId>/launch" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"projectId": "00000000-0000-4000-8000-000000000000",
"scheduledAt": 0,
"skipMissingVariables": true
}'{
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"status": "draft",
"operationId": "00000000-0000-4000-8000-000000000000"
}
}Pause campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Pauses a running campaign. Sends already in progress can still finish. 409 means the campaign is not running or has no active delivery run to pause.
Requires campaigns:manage. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Headers
Idempotency-Keystringlength1–255Optional unique key, 1 to 255 bytes, that makes this request safe to retry for 1 hour. A retry with the same key, credential,
Polymorfa-Versionand request never runs it again while its receipt is retained. Keep the first response. Opaque campaign bodies are not retained by default; an available authorized exact replay carriesIdempotent-Replayed: true. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns422 idempotency_conflict. A retry while the original is still running returns409 idempotency_in_progress, and a retry after an unrecorded outcome returns409 idempotency_outcome_unknown. If the recorded response cannot be read, the retry returns503 idempotency_replay_unavailablewithRetry-After; the request does not run again. Missing replay data never releases the execution fence.
Body
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 3 child fields
Show 4 headers
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
404The requested resource was not found inside the authenticated team or project scope.
409The request conflicts with the resource's current state.
422The Idempotency-Key was already used for a different request (`idempotency_conflict`).
503`idempotency_replay_unavailable`: the recorded response cannot be read. The original request is not run again, and its execution fence remains in place. Keep the first response; do not switch keys to resend.
curl -X POST "https://api.polymorfa.com/platform/campaigns/<campaignId>/pause" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{}'{
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"status": "draft",
"operationId": "00000000-0000-4000-8000-000000000000"
}
}Resume campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Resumes a paused campaign. Its remaining recipients are sent after the same checks as before the pause. 409 means the campaign is not paused or has no active delivery run to resume. A request through the hosted MCP server answers 409 campaign_approval_required, changes nothing, and records an approval request that a team owner or admin approves in the console.
Requires campaigns:manage. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Headers
Idempotency-Keystringlength1–255Optional unique key, 1 to 255 bytes, that makes this request safe to retry for 1 hour. A retry with the same key, credential,
Polymorfa-Versionand request never runs it again while its receipt is retained. Keep the first response. Opaque campaign bodies are not retained by default; an available authorized exact replay carriesIdempotent-Replayed: true. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns422 idempotency_conflict. A retry while the original is still running returns409 idempotency_in_progress, and a retry after an unrecorded outcome returns409 idempotency_outcome_unknown. If the recorded response cannot be read, the retry returns503 idempotency_replay_unavailablewithRetry-After; the request does not run again. Missing replay data never releases the execution fence.
Body
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 3 child fields
Show 4 headers
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
404The requested resource was not found inside the authenticated team or project scope.
409The request conflicts with the resource's current state.
422The Idempotency-Key was already used for a different request (`idempotency_conflict`).
503`idempotency_replay_unavailable`: the recorded response cannot be read. The original request is not run again, and its execution fence remains in place. Keep the first response; do not switch keys to resend.
curl -X POST "https://api.polymorfa.com/platform/campaigns/<campaignId>/resume" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{}'{
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"status": "draft",
"operationId": "00000000-0000-4000-8000-000000000000"
}
}Reschedule campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Moves the start of a launched campaign that is still waiting for it. Set scheduledAt to a later or earlier time, or to null to start now. The response returns the campaign with its new scheduledAt; sending the current start time again changes nothing. A suspended team is refused with 403 bansafe_team_suspended. 409 means the campaign has already started, is finished or being stopped, or was never launched; launch a draft with scheduledAt instead. A request through the hosted MCP server answers 409 campaign_approval_required, changes nothing, and records an approval request that a team owner or admin approves in the console.
Requires campaigns:manage. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Headers
Idempotency-Keystringlength1–255Optional unique key, 1 to 255 bytes, that makes this request safe to retry for 1 hour. A retry with the same key, credential,
Polymorfa-Versionand request never runs it again while its receipt is retained. Keep the first response. Opaque campaign bodies are not retained by default; an available authorized exact replay carriesIdempotent-Replayed: true. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns422 idempotency_conflict. A retry while the original is still running returns409 idempotency_in_progress, and a retry after an unrecorded outcome returns409 idempotency_outcome_unknown. If the recorded response cannot be read, the retry returns503 idempotency_replay_unavailablewithRetry-After; the request does not run again. Missing replay data never releases the execution fence.
Body
scheduledAtintegerrequirednullablerange1–8640000000000000The new start time in Unix milliseconds.
null, or a time that is not in the future, starts the campaign now.projectIdstring (uuid)Required when using a team API key. Project tokens derive the project from the credential.
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 3 child fields
Show 4 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.
404The requested resource was not found inside the authenticated team or project scope.
409The request conflicts with the resource's current state.
422The Idempotency-Key was already used for a different request (`idempotency_conflict`).
503`idempotency_replay_unavailable`: the recorded response cannot be read. The original request is not run again, and its execution fence remains in place. Keep the first response; do not switch keys to resend.
curl -X POST "https://api.polymorfa.com/platform/campaigns/<campaignId>/reschedule" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"scheduledAt": 1
}'{
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"status": "draft",
"operationId": "00000000-0000-4000-8000-000000000000"
}
}Archive campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Archives a completed, failed or cancelled campaign. Other states return 409. A final event pending delivery or an active delivery run also returns 409; retry after both finish.
Requires campaigns:manage. Project tokens only access resources in their own project.
Archive a completed, failed or cancelled campaign. Wait for a stopping campaign to reach cancelled before archiving it.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Body
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 3 headers
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
404The requested resource was not found inside the authenticated team or project scope.
409The request conflicts with the resource's current state.
curl -X POST "https://api.polymorfa.com/platform/campaigns/<campaignId>/archive" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{}'{
"data": {}
}Duplicate campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Creates a new draft from a campaign. Segment campaigns require a team API key or signed-in dashboard session; project tokens answer 403 permission_denied. Both audience betas must be available, otherwise duplication answers 403 feature_unavailable. The copy evaluates the saved segment again at launch and never copies its frozen recipients. If the segment was deleted, answers 409 state_conflict; create a new campaign and choose an audience. An audience change during duplication also answers 409 state_conflict.
Requires campaigns:manage. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Body
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 35 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.
404The requested resource was not found inside the authenticated team or project scope.
409The request conflicts with the resource's current state.
curl -X POST "https://api.polymorfa.com/platform/campaigns/<campaignId>/duplicate" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{}'{
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"name": "string",
"status": "string",
"templateId": "00000000-0000-4000-8000-000000000000",
"recipientListId": "00000000-0000-4000-8000-000000000000",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"scheduledAt": 0,
"launchedAt": 0,
"completedAt": 0,
"createdAt": 0,
"updatedAt": 0,
"sendWindow": {
"timeZone": "string",
"days": [
"monday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
],
"recipientTimeZone": true,
"timeZoneVariable": "string"
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": false
},
"enrollmentOpen": true,
"pauseReason": "string",
"followUp": {
"message": {
"type": "text",
"text": "string"
}
},
"experimentOutcome": {
"state": "promoted"
},
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
}
}
}Requeue failed campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Public Management API. Requires campaigns:manage. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Body
Responses
200Success
dataanyrequiredOperation result.
Show 3 headers
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
curl -X POST "https://api.polymorfa.com/platform/campaigns/<campaignId>/requeue" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{}'{
"data": null
}Enroll campaign contact
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Beta. Adds one contact to a running or paused continuous drip. Requires campaigns:manage and the drip beta; otherwise 403 feature_unavailable. Idempotent per phone, including contacts who completed or exited: returns created=false without changing variables. Opted-out contacts are skipped. A campaign not accepting enrollment answers 409 state_conflict.
Requires campaigns:manage. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Body
projectIdstring (uuid)Identifier of the Polymorfa project that owns this resource.
phonestringrequiredlength1–32International phone number.
variablesobjectmax properties50Structured variables values for this management enroll campaign contact request.
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 6 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.
404The requested resource was not found inside the authenticated team or project scope.
409The request conflicts with the resource's current state.
curl -X POST "https://api.polymorfa.com/platform/campaigns/<campaignId>/enrollments" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"phone": "string"
}'{
"data": {
"campaignId": "00000000-0000-4000-8000-000000000000",
"recipientId": "00000000-0000-4000-8000-000000000000",
"phone": "string",
"created": true,
"status": "string",
"enrolledAt": 0
}
}Test send campaign
- Base URL
https://api.polymorfa.com
Requires campaigns:manage and campaigns:read because the test can use stored recipient samples. Sends one copy of a draft campaign's content to a seed recipient, through the same rendering, sending and BanSafe checks as a launched campaign. The seed recipient must be a number connected to your team. The sending number must be connected, on a plan that includes Campaigns and, when the campaign selects numbers, one of them. A test is not a campaign recipient and is not counted in the campaign's statistics or webhooks. A team can send 20 tests an hour, and at most 5 an hour to one seed recipient. 429 means one of these limits was reached or BanSafe is pacing the sending number; follow Retry-After. 409 bansafe_cold_held means the seed recipient has never written to the sending number and the campaign holds first messages. 409 state_conflict means the campaign is not a draft or has A/B or weighted content alternatives, the sending number is a Hybrid Link number, or the seed recipient opted out. 504 result_unknown means the outcome was not received in time and the test may still arrive. Send projectId in the body when using a team API key. 422 campaign_variables_missing means the test's sample values, the mapped recipient value and the fallback all leave a variable in the campaign content empty.
Requires campaigns:manage and campaigns:read. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Headers
Idempotency-Keystringlength1–255Optional unique key, 1 to 255 bytes, that makes this request safe to retry for 1 hour. A retry with the same key, credential,
Polymorfa-Versionand request never runs it again while its receipt is retained. Keep the first response. Opaque campaign bodies are not retained by default; an available authorized exact replay carriesIdempotent-Replayed: true. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns422 idempotency_conflict. A retry while the original is still running returns409 idempotency_in_progress, and a retry after an unrecorded outcome returns409 idempotency_outcome_unknown. If the recorded response cannot be read, the retry returns503 idempotency_replay_unavailablewithRetry-After; the request does not run again. Missing replay data never releases the execution fence.
Body
projectIdstring (uuid)Required when using a team API key. Project tokens derive the project from the credential.
sessionIdstring (uuid)requiredThe number to send the test from. It must be connected, on a plan that includes Campaigns and, when the campaign selects numbers, one of them.
tostringrequiredlength1–32The seed recipient in international format. It must be the phone of a number connected to your team.
sampleRecipientIdstring (uuid)A recipient of this campaign whose variables fill the content. Without it and without
variables, the campaign's first recipient, or its audience's first member, is the sample.variablesobjectmax properties50Variable values for the test. They override the sample recipient's values; without
sampleRecipientId, only these values are used.
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 8 child fields
Show 4 headers
400A path, query, or request-body value did not pass validation.
401Missing/invalid credential for this audience.
402`campaigns_not_entitled`: a sending number is missing or its plan does not include Campaigns.
403Authenticated but lacks the required scope/role/audience.
404The requested resource was not found inside the authenticated team or project scope.
409The request conflicts with the resource's current state.
422`campaign_variables_missing`: a recipient or test sample has no value or fallback for a campaign variable; nothing was sent by that request. `idempotency_conflict`: this key belongs to a different request; the earlier request is not run again and this refusal does not establish its outcome.
429A limit was reached. Wait for `Retry-After` before retrying.
502`upstream_failure`: the messaging provider could not complete the send.
503`idempotency_replay_unavailable`: the recorded response cannot be read. The original request is not run again, and its execution fence remains in place. Keep the first response; do not switch keys to resend. The send path can also be unavailable before a send (`session_not_ready`, `command_dispatch_failed`, `service_unavailable`, or `bansafe_accounting_unavailable`).
504`result_unknown`: the outcome was not received before the deadline. The message may still arrive; check before repeating the request.
curl -X POST "https://api.polymorfa.com/platform/campaigns/<campaignId>/test-send" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"sessionId": "00000000-0000-4000-8000-000000000000",
"to": "+5511999990000"
}'{
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"campaignId": "00000000-0000-4000-8000-000000000000",
"status": "sent",
"from": {
"sessionId": "00000000-0000-4000-8000-000000000000",
"phone": "string"
},
"to": "string",
"messageId": "string",
"variables": {},
"createdAt": 0
}
}Set campaign reply flow
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Attaches a reply flow revision to a draft or scheduled campaign, or detaches it with null. The flow starts for each recipient once their message is sent. 409 means the campaign has already launched. Beta: returns 403 unless campaign reply flows are enabled for the team.
Requires campaigns:manage. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Body
replyFlowIdstring (uuid)requirednullableReply flow revision to run after replies, or null to detach it.
projectIdstring (uuid)Required when using a team API key. Project tokens derive the project from the credential.
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 2 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.
404The requested resource was not found inside the authenticated team or project scope.
409The request conflicts with the resource's current state.
curl -X PUT "https://api.polymorfa.com/platform/campaigns/<campaignId>/reply-flow" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"replyFlowId": "00000000-0000-4000-8000-000000000000"
}'{
"data": {
"campaignId": "00000000-0000-4000-8000-000000000000",
"replyFlowId": "00000000-0000-4000-8000-000000000000"
}
}Add campaign recipients
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Adds up to 1,000 recipients to a campaign that has not been launched. A number already on the campaign is skipped. Invalid entries are reported, not added. A campaign that has been launched answers 409. Send projectId in the body when using a team API key.
Requires campaigns:manage. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Headers
Idempotency-Keystringlength1–255Optional key, 1 to 255 bytes of UTF-8, that makes this request safe to retry for 24 hours. A retry with the same key, credential,
Polymorfa-Versionand request is not applied again: it returns200withIdempotent-Replayed: trueand the replay result described for this operation. Reusing the key for a different request returns422 idempotency_conflict. A retry sent while the original is still running waits for it and then returns its result. A request that failed left no record, so retrying it with the same key runs it again. Access to the resource is checked again on every retry. A replay returns the original counts, even after the campaign has launched.
Body
projectIdstring (uuid)Identifier of the Polymorfa project that owns this resource.
recipientsarray of objectrequireditems1–1000At most 1,000 recipients per request.
Show 2 child fields
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 6 child fields
Show 4 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.
404The requested resource was not found inside the authenticated team or project scope.
409The request conflicts with the resource's current state.
422The Idempotency-Key was already used for a different request (`idempotency_conflict`).
curl -X POST "https://api.polymorfa.com/platform/campaigns/<campaignId>/recipients" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"recipients": [
{
"phone": "string"
}
]
}'{
"data": {
"campaignId": "00000000-0000-4000-8000-000000000000",
"added": 0,
"recipientCount": 0,
"duplicateCount": 0,
"invalidCount": 0,
"invalidRows": [
{
"row": 1,
"reason": "missing_phone"
}
]
}
}Export campaign recipients
- Base URL
https://api.polymorfa.com- Required permission
campaigns:read
Returns recipients as CSV in queue order. Unfiltered exports page up to 1,000 recipients per request, using the Polymorfa-Next-Cursor response header. Each page starts with a header row and reflects outcomes when requested. Filtered exports are one atomic page of up to 1,000 recipients; larger filtered results return 409, so changing statuses cannot silently omit matches between pages. The export contains outcomes and failureReason codes only, never message content or template variables.
Requires campaigns:read. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Query parameters
projectIdstring (uuid)Project the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it.
statusstringCurrent status of this resource or operation.
Allowed valuesqueuedsendingsentdeliveredreadfailedskippedreasonstringOnly recipients whose
failureReasonis this code.Allowed valuesopted_outcold_heldcampaign_cancelledinvalid_recipientsession_not_connectedack_timeoutblocked_by_safetysend_failedmissing_variablefrequency_capothercursorstringlength1–256Specifies cursor for this query parameter.
limitintegerrange1–1000Specifies limit for this query parameter.
Default1000
Responses
200One CSV page.
Content type
text/csvShow 4 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.
404The requested resource was not found inside the authenticated team or project scope.
409The request conflicts with the resource's current state.
curl "https://api.polymorfa.com/platform/campaigns/<campaignId>/recipients/export" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"Content type text/csv
No example for this content type
Stop project campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Cancels a draft, running, or paused campaign. Recipients not yet sent are not sent. The campaign moves to cancelling and then to cancelled once sends already in progress finish; a campaign with no active delivery run is cancelled immediately.
Path parameters
projectSlugstringrequiredSpecifies project slug for this path parameter.
idstringrequiredIdentifier for this resource.
Headers
Idempotency-Keystringlength1–255Unique key, 1 to 255 bytes of UTF-8, that makes this write safe to retry for 1 hour. A retry with the same key, credential,
Polymorfa-Version, and request never runs the write again while its receipt is retained. Keep the first response. Exact response replay requires authorized replay data; opaque message or campaign bodies are not retained by default. An available exact replay carriesIdempotent-Replayed: true. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns422 idempotency_conflict. A retry while the original is still running returns409 idempotency_in_progress, and a retry after an unrecorded outcome returns409 idempotency_outcome_unknown. If the recorded response cannot be read, the retry returns503 idempotency_replay_unavailablewithRetry-Afterand the write still does not run again.
Responses
200OK
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 31 child fields
Show 4 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
409`state_conflict`: The campaign is already finished or cancelled. The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)
422The Idempotency-Key was already used for a different request (`idempotency_conflict`)
500Internal server error
503For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend
curl -X POST "https://api.polymorfa.com/messaging/projects/<projectSlug>/campaigns/<id>/stop" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": {
"id": "string",
"name": "string",
"status": "string",
"templateId": "string",
"recipientListId": "string",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"skippedCount": 0,
"scheduledAt": 0,
"launchedAt": 0,
"completedAt": 0,
"createdAt": 0,
"updatedAt": 0,
"experimentOutcome": {
"state": "promoted"
},
"followUp": {
"message": {
"type": "text",
"text": "string"
}
},
"sendWindow": {
"timeZone": "America/Sao_Paulo",
"days": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
],
"hours": [
{
"start": "09:00",
"end": "18:00"
}
],
"recipientTimeZone": true,
"timeZoneVariable": "timeZone"
},
"trackedLinks": [
{
"key": "offer",
"url": "https://example.com/spring-sale"
}
],
"drip": {
"enrollment": "audience",
"exitOnReply": true,
"exitOnLinkClick": true
},
"enrollmentOpen": true,
"pauseReason": "string",
"frequencyCap": {
"maxPer24Hours": 1,
"maxPer7Days": 1
},
"operationId": "00000000-0000-4000-8000-000000000000"
}
}Stop campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Cancels a draft, running or paused campaign. Recipients not yet sent are not sent. The campaign moves to cancelling and then to cancelled once sends already in progress finish; a campaign with no active delivery run is cancelled immediately and operationId is null. 409 means the campaign is already finished or cancelled.
Requires campaigns:manage. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Headers
Idempotency-Keystringlength1–255Optional unique key, 1 to 255 bytes, that makes this request safe to retry for 1 hour. A retry with the same key, credential,
Polymorfa-Versionand request never runs it again while its receipt is retained. Keep the first response. Opaque campaign bodies are not retained by default; an available authorized exact replay carriesIdempotent-Replayed: true. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns422 idempotency_conflict. A retry while the original is still running returns409 idempotency_in_progress, and a retry after an unrecorded outcome returns409 idempotency_outcome_unknown. If the recorded response cannot be read, the retry returns503 idempotency_replay_unavailablewithRetry-After; the request does not run again. Missing replay data never releases the execution fence.
Body
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 3 child fields
Show 4 headers
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
404The requested resource was not found inside the authenticated team or project scope.
409The request conflicts with the resource's current state.
422The Idempotency-Key was already used for a different request (`idempotency_conflict`).
503`idempotency_replay_unavailable`: the recorded response cannot be read. The original request is not run again, and its execution fence remains in place. Keep the first response; do not switch keys to resend.
curl -X POST "https://api.polymorfa.com/platform/campaigns/<campaignId>/stop" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{}'{
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"status": "draft",
"operationId": "00000000-0000-4000-8000-000000000000"
}
}Delete campaign
- Base URL
https://api.polymorfa.com- Required permission
campaigns:manage
Deletes a draft, completed, failed, cancelled or archived campaign. Any other campaign is refused with 409; stop it first. A completed or failed campaign with a final event pending delivery or an active delivery run is also refused with 409; retry after both finish.
Requires campaigns:manage. Project tokens only access resources in their own project.
Path parameters
campaignIdstringrequiredIdentifier for the campaign.
Query parameters
projectIdstringProject the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it.
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 1 child field
Show 3 headers
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
404The requested resource was not found inside the authenticated team or project scope.
409The request conflicts with the resource's current state.
curl -X DELETE "https://api.polymorfa.com/platform/campaigns/<campaignId>" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": {
"removed": true
}
}