polymorfa campaign
Inspect and manage Messaging campaigns.
polymorfa campaign analytics
View exact live counters for one campaign.
Usage
polymorfa campaign analytics CAMPAIGN [flags]Arguments
CAMPAIGNrequiredCampaign ID.
Flags
--project-slug <value>takes a valuerequiredProject slug in the Messaging API path.
Also accepts the global flags.
polymorfa campaign conversions record
Report a conversion for one campaign recipient (beta; requires team enrollment).
Report a conversion for one campaign recipient (beta; requires team enrollment).
It is attributed to the campaign when --occurred-at is within 7 days after the recipient was sent. Sending the same --event-id with the same details again returns the original conversion; changed details are refused. Amounts are integer minor units of the currency and are never converted.
Usage
polymorfa campaign conversions record CAMPAIGN [flags]Example
polymorfa campaign conversions record <campaignId> --project-id <projectId> --recipient <recipientId> --event-id order-1001 --event-type purchase --occurred-at 2026-10-01T10:00:00Z --amount-minor 1999 --currency USDArguments
CAMPAIGNrequiredCampaign ID.
Flags
--amount-minor <value>takes a valueReported value in the currency minor unit, for example 1999 for USD 19.99.
--currency <value>takes a valueISO 4217 currency code of --amount-minor, for example USD.
--event-id <value>takes a valuerequiredYour unique ID for this conversion, such as an order ID.
--event-type <value>takes a valuerequiredKind of conversion, such as purchase or sign_up.
--occurred-at <value>takes a valuerequiredWhen it happened, as an ISO 8601 date-time with a time zone offset.
--project-id <value>takes a valuerequiredProject that owns the campaign.
--recipient <value>takes a valuerequiredCampaign recipient ID, from campaign recipients list.
Also accepts the global flags.
polymorfa campaign conversions report
View a campaign's reported conversions by attribution outcome, with reported value per currency (beta; requires team enrollment). Currencies are never combined or converted.
Usage
polymorfa campaign conversions report CAMPAIGN [flags]Example
polymorfa campaign conversions report <campaignId> --project-id <projectId>Arguments
CAMPAIGNrequiredCampaign ID.
Flags
--project-id <value>takes a valuerequiredProject that owns the campaign.
Also accepts the global flags.
polymorfa campaign create
Create a campaign from one JSON object. Optional beta fields include followUp: one receipt-timed follow-up ({delaySeconds, expirySeconds, message: {type: "text", text} or {type: "template", templateId}}); teams that are not enrolled receive 403 feature_unavailable.
Usage
polymorfa campaign create [flags]Flags
--dripbooleanEnable drip sequences (beta).
--drip-enrollment <value>takes a valueDrip enrollment mode. Audience closes continuous enrollment.
Allowed valuesaudiencecontinuous--drip-exit-on-link-clickbooleanStop remaining steps on tracked-link GET, including preview/scanner GETs.
--drip-exit-on-replybooleanStop remaining steps after a reply.
--frequency-cap-24-hours <value>takes a valuePer-contact rolling 24-hour limit (beta).
--frequency-cap-7-days <value>takes a valuePer-contact rolling 7-day limit (beta).
--idempotency-key <value>takes a valueIdempotency-Key header. Generated per invocation when omitted; reuse an explicit key across process retries (24-hour retention).
--input <value>takes a valuerequiredRead the campaign JSON object from a file or stdin (-).
--project-id <value>takes a valueOwning project ID for Platform campaign content, segments and drip steps.
--project-slug <value>takes a valueProject slug in the Messaging API path.
--remove-dripbooleanRemove drip settings from an unlaunched draft.
--remove-frequency-capbooleanRemove the campaign cap; the team cap still applies.
--segment <value>takes a valueSaved audience segment ID (team key; requires --project-id).
Also accepts the global flags.
polymorfa campaign enroll
Enroll one phone in a running or paused continuous drip (beta). Existing enrollments never restart.
Usage
polymorfa campaign enroll CAMPAIGN [flags]Arguments
CAMPAIGNrequiredCampaign ID.
Flags
--phone <value>takes a valuerequiredInternational phone number.
--project-slug <value>takes a valuerequiredOwning project slug.
--variables <value>takes a valueVariables JSON file or stdin (-).
Also accepts the global flags.
polymorfa campaign launch
Request immediate or scheduled campaign launch.
Usage
polymorfa campaign launch CAMPAIGN [flags]Arguments
CAMPAIGNrequiredCampaign ID.
Flags
--idempotency-key <value>takes a valueIdempotency-Key header. Generated per invocation when omitted; reuse an explicit key across process retries (24-hour retention).
--project-slug <value>takes a valuerequiredProject slug in the Messaging API path.
--scheduled-at <value>takes a valueLaunch time as epoch milliseconds or an ISO 8601 instant.
Also accepts the global flags.
polymorfa campaign list
List the complete newest-first campaign array for one project.
Usage
polymorfa campaign list [flags]Flags
--project-slug <value>takes a valuerequiredProject slug in the Messaging API path.
Also accepts the global flags.
polymorfa campaign pause
Request that a running campaign pause.
Usage
polymorfa campaign pause CAMPAIGN [flags]Arguments
CAMPAIGNrequiredCampaign ID.
Flags
--idempotency-key <value>takes a valueDeduplicate this request for 24 hours. A completed key returns 409 idempotency_completed.
--project-slug <value>takes a valuerequiredProject slug in the Messaging API path.
Also accepts the global flags.
polymorfa campaign recipients add
Add up to 1000 recipients to a campaign that has not started sending. Repeated phone numbers are skipped and invalid entries are reported, not added.
Usage
polymorfa campaign recipients add CAMPAIGN [flags]Examples
polymorfa campaign recipients add 018f0000-0000-7000-8000-000000000001 --project-slug launch --csv contacts.csv --variable firstName="First name"polymorfa campaign recipients add 018f0000-0000-7000-8000-000000000001 --project-slug launch --input recipients.jsonArguments
CAMPAIGNrequiredCampaign ID.
Flags
--csv <value>takes a valueRead recipients from this spreadsheet and send them inline.
--idempotency-key <value>takes a valueSend this Idempotency-Key header. The API does not replay appends, so the request is sent once and not retried.
--input <value>takes a valueRead a JSON array of {phone, variables} from a file or stdin (-).
--phone-column <value>takes a valueHeader naming the phone column. Defaults to phone.
--project-slug <value>takes a valuerequiredProject slug in the Messaging API path.
--variable <value>takes a valuerepeatableMap a template variable to a column, as name=column. Repeatable; quote a column name that contains spaces.
Also accepts the global flags.
polymorfa campaign recipients list
List one page of a campaign’s recipients in queue order.
Usage
polymorfa campaign recipients list CAMPAIGN [flags]Example
polymorfa campaign recipients list 018f0000-0000-7000-8000-000000000001 --project-slug launch --status skippedArguments
CAMPAIGNrequiredCampaign ID.
Flags
--cursor <value>takes a valueContinue from this opaque cursor.
--limit <value>takes a valueRequest this many recipients. The API defaults to 25.
--project-slug <value>takes a valuerequiredProject slug in the Messaging API path.
--reason <value>takes a valueFilter by recipient failure reason, including frequency_cap.
--status <value>takes a valueFilter by delivery status. Use skipped to find recipients suppressed by an opt-out.
Allowed valuesqueuedsendingsentdeliveredreadfailedskipped
Also accepts the global flags.
polymorfa campaign requeue
Requeue failed recipients and optionally skipped recipients with errors.
Usage
polymorfa campaign requeue CAMPAIGN [flags]Arguments
CAMPAIGNrequiredCampaign ID.
Flags
--idempotency-key <value>takes a valueSend this request identity without replay protection. A retry can requeue newly failed recipients.
--include-skipped-errorbooleanAlso requeue recipients skipped with an error.
--project-slug <value>takes a valuerequiredProject slug in the Messaging API path.
Also accepts the global flags.
polymorfa campaign resume
Request that a paused campaign resume.
Usage
polymorfa campaign resume CAMPAIGN [flags]Arguments
CAMPAIGNrequiredCampaign ID.
Flags
--idempotency-key <value>takes a valueDeduplicate this request for 24 hours. A completed key returns 409 idempotency_completed.
--project-slug <value>takes a valuerequiredProject slug in the Messaging API path.
Also accepts the global flags.
polymorfa campaign segments count
Count audience segments (team key; beta gates and observed revisions apply).
Usage
polymorfa campaign segments count [SEGMENT] [flags]Arguments
SEGMENToptionalSaved segment ID.
Flags
--input <value>takes a valueUnsaved rules object from JSON file or stdin (-). Use instead of a segment ID.
Also accepts the global flags.
polymorfa campaign segments create
Create audience segments (team key; beta gates and observed revisions apply).
Usage
polymorfa campaign segments create [flags]Flags
--input <value>takes a valuerequiredJSON object from file or stdin (-). Update includes expectedRevision.
Also accepts the global flags.
polymorfa campaign segments delete
Delete audience segments (team key; beta gates and observed revisions apply).
Usage
polymorfa campaign segments delete SEGMENT [flags]Arguments
SEGMENTrequiredSaved segment ID.
Flags
--revision <value>takes a valuerequiredObserved segment revision.
Also accepts the global flags.
polymorfa campaign segments get
Get audience segments (team key; beta gates and observed revisions apply).
Usage
polymorfa campaign segments get SEGMENT [flags]Arguments
SEGMENTrequiredSaved segment ID.
Flags
Also accepts the global flags.
polymorfa campaign segments list
List audience segments (team key; beta gates and observed revisions apply).
Usage
polymorfa campaign segments list [flags]Flags
--cursor <value>takes a valueNext page cursor.
--limit <value>takes a valuePage size (1-100).
Also accepts the global flags.
polymorfa campaign segments update
Update audience segments (team key; beta gates and observed revisions apply).
Usage
polymorfa campaign segments update SEGMENT [flags]Arguments
SEGMENTrequiredSaved segment ID.
Flags
--input <value>takes a valuerequiredJSON object from file or stdin (-). Update includes expectedRevision.
Also accepts the global flags.
polymorfa campaign settings frequency-cap get
Read team contact frequency caps and their revision.
Usage
polymorfa campaign settings frequency-cap get [flags]Flags
Also accepts the global flags.
polymorfa campaign settings frequency-cap remove
Remove both team limits, including without beta access. Requires the last read revision.
Usage
polymorfa campaign settings frequency-cap remove [flags]Flags
--revision <value>takes a valuerequiredRevision from get. On 409, read again and reconcile before retrying.
Also accepts the global flags.
polymorfa campaign settings frequency-cap set
Replace team limits (beta). Omitted windows become unlimited. Stale revisions return 409; no automatic retry.
Usage
polymorfa campaign settings frequency-cap set [flags]Flags
--max-per-24-hours <value>takes a valueRolling 24-hour limit; omitted means no limit.
--max-per-7-days <value>takes a valueRolling 7-day limit; omitted means no limit.
--revision <value>takes a valuerequiredRevision from get. On 409, read again and reconcile before retrying.
Also accepts the global flags.
polymorfa campaign stop
Permanently stop a campaign. A campaign with no active delivery run is cancelled immediately and returns no operation ID.
Usage
polymorfa campaign stop CAMPAIGN [flags]Arguments
CAMPAIGNrequiredCampaign ID.
Flags
--idempotency-key <value>takes a valueDeduplicate this request for 24 hours. A completed key returns 409 idempotency_completed.
--project-slug <value>takes a valuerequiredProject slug in the Messaging API path.
--yesbooleanrequiredConfirm this terminal campaign transition.
Also accepts the global flags.
polymorfa campaign update
Update a campaign. Omitted drip fields preserve stored values; enrollment-only audience closes enrollment. Cap flags replace the campaign cap; omitted cap windows have no campaign limit.
Usage
polymorfa campaign update CAMPAIGN [flags]Arguments
CAMPAIGNrequiredCampaign ID.
Flags
--dripbooleanEnable drip sequences (beta).
--drip-enrollment <value>takes a valueDrip enrollment mode. Audience closes continuous enrollment.
Allowed valuesaudiencecontinuous--drip-exit-on-link-clickbooleanStop remaining steps on tracked-link GET, including preview/scanner GETs.
--drip-exit-on-replybooleanStop remaining steps after a reply.
--frequency-cap-24-hours <value>takes a valuePer-contact rolling 24-hour limit (beta).
--frequency-cap-7-days <value>takes a valuePer-contact rolling 7-day limit (beta).
--input <value>takes a valueChanges from JSON file or stdin (-).
--project-id <value>takes a valueOwning project ID (Platform content and settings).
--project-slug <value>takes a valueOwning project slug (Messaging settings).
--remove-dripbooleanRemove drip settings from an unlaunched draft.
--remove-frequency-capbooleanRemove the campaign cap; the team cap still applies.
Also accepts the global flags.
polymorfa campaign view
View one campaign.
Usage
polymorfa campaign view CAMPAIGN [flags]Arguments
CAMPAIGNrequiredCampaign ID.
Flags
--project-slug <value>takes a valuerequiredProject slug in the Messaging API path.
Also accepts the global flags.