# polymorfa campaign

> Inspect and manage Messaging campaigns.

## Commands

- [polymorfa campaign analytics](https://docs.polymorfa.com/cli/campaign/analytics): View exact live counters for one campaign.
- [polymorfa campaign conversions record](https://docs.polymorfa.com/cli/campaign/conversions-record): Report a conversion for one campaign recipient (beta; requires team enrollment).
- [polymorfa campaign conversions report](https://docs.polymorfa.com/cli/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.
- [polymorfa campaign create](https://docs.polymorfa.com/cli/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.
- [polymorfa campaign enroll](https://docs.polymorfa.com/cli/campaign/enroll): Enroll one phone in a running or paused continuous drip (beta). Existing enrollments never restart.
- [polymorfa campaign launch](https://docs.polymorfa.com/cli/campaign/launch): Request immediate or scheduled campaign launch.
- [polymorfa campaign list](https://docs.polymorfa.com/cli/campaign/list): List the complete newest-first campaign array for one project.
- [polymorfa campaign pause](https://docs.polymorfa.com/cli/campaign/pause): Request that a running campaign pause.
- [polymorfa campaign recipients add](https://docs.polymorfa.com/cli/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.
- [polymorfa campaign recipients list](https://docs.polymorfa.com/cli/campaign/recipients-list): List one page of a campaign’s recipients in queue order.
- [polymorfa campaign requeue](https://docs.polymorfa.com/cli/campaign/requeue): Requeue failed recipients and optionally skipped recipients with errors.
- [polymorfa campaign resume](https://docs.polymorfa.com/cli/campaign/resume): Request that a paused campaign resume.
- [polymorfa campaign segments count](https://docs.polymorfa.com/cli/campaign/segments-count): Count audience segments (team key; beta gates and observed revisions apply).
- [polymorfa campaign segments create](https://docs.polymorfa.com/cli/campaign/segments-create): Create audience segments (team key; beta gates and observed revisions apply).
- [polymorfa campaign segments delete](https://docs.polymorfa.com/cli/campaign/segments-delete): Delete audience segments (team key; beta gates and observed revisions apply).
- [polymorfa campaign segments get](https://docs.polymorfa.com/cli/campaign/segments-get): Get audience segments (team key; beta gates and observed revisions apply).
- [polymorfa campaign segments list](https://docs.polymorfa.com/cli/campaign/segments-list): List audience segments (team key; beta gates and observed revisions apply).
- [polymorfa campaign segments update](https://docs.polymorfa.com/cli/campaign/segments-update): Update audience segments (team key; beta gates and observed revisions apply).
- [polymorfa campaign settings frequency-cap get](https://docs.polymorfa.com/cli/campaign/settings-frequency-cap-get): Read team contact frequency caps and their revision.
- [polymorfa campaign settings frequency-cap remove](https://docs.polymorfa.com/cli/campaign/settings-frequency-cap-remove): Remove both team limits, including without beta access. Requires the last read revision.
- [polymorfa campaign settings frequency-cap set](https://docs.polymorfa.com/cli/campaign/settings-frequency-cap-set): Replace team limits (beta). Omitted windows become unlimited. Stale revisions return 409; no automatic retry.
- [polymorfa campaign stop](https://docs.polymorfa.com/cli/campaign/stop): Permanently stop a campaign. A campaign with no active delivery run is cancelled immediately and returns no operation ID.
- [polymorfa campaign update](https://docs.polymorfa.com/cli/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.
- [polymorfa campaign view](https://docs.polymorfa.com/cli/campaign/view): View one campaign.

## polymorfa campaign analytics

View exact live counters for one campaign.

### Usage

```bash
polymorfa campaign analytics CAMPAIGN [flags]
```

### Arguments

- `CAMPAIGN` (required). Campaign ID.

### Flags

- `--project-slug <value>` (value, required). Project slug in the Messaging API path.

Also accepts the [global flags](https://docs.polymorfa.com/cli#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

```bash
polymorfa campaign conversions record CAMPAIGN [flags]
```

### Arguments

- `CAMPAIGN` (required). Campaign ID.

### Flags

- `--amount-minor <value>` (value). Reported value in the currency minor unit, for example 1999 for USD 19.99.
- `--currency <value>` (value). ISO 4217 currency code of --amount-minor, for example USD.
- `--event-id <value>` (value, required). Your unique ID for this conversion, such as an order ID.
- `--event-type <value>` (value, required). Kind of conversion, such as purchase or sign_up.
- `--occurred-at <value>` (value, required). When it happened, as an ISO 8601 date-time with a time zone offset.
- `--project-id <value>` (value, required). Project that owns the campaign.
- `--recipient <value>` (value, required). Campaign recipient ID, from campaign recipients list.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

### Examples

```bash
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 USD
```

## 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

```bash
polymorfa campaign conversions report CAMPAIGN [flags]
```

### Arguments

- `CAMPAIGN` (required). Campaign ID.

### Flags

- `--project-id <value>` (value, required). Project that owns the campaign.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

### Examples

```bash
polymorfa campaign conversions report <campaignId> --project-id <projectId>
```

## 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

```bash
polymorfa campaign create [flags]
```

### Flags

- `--drip` (boolean). Enable drip sequences (beta).
- `--drip-enrollment <value>` (value). Drip enrollment mode. Audience closes continuous enrollment. Values: `audience`, `continuous`.
- `--drip-exit-on-link-click` (boolean). Stop remaining steps on tracked-link GET, including preview/scanner GETs.
- `--drip-exit-on-reply` (boolean). Stop remaining steps after a reply.
- `--frequency-cap-24-hours <value>` (value). Per-contact rolling 24-hour limit (beta).
- `--frequency-cap-7-days <value>` (value). Per-contact rolling 7-day limit (beta).
- `--idempotency-key <value>` (value). Idempotency-Key header. Generated per invocation when omitted; reuse an explicit key across process retries (24-hour retention).
- `--input <value>` (value, required). Read the campaign JSON object from a file or stdin (-).
- `--project-id <value>` (value). Owning project ID for Platform campaign content, segments and drip steps.
- `--project-slug <value>` (value). Project slug in the Messaging API path.
- `--remove-drip` (boolean). Remove drip settings from an unlaunched draft.
- `--remove-frequency-cap` (boolean). Remove the campaign cap; the team cap still applies.
- `--segment <value>` (value). Saved audience segment ID (team key; requires --project-id).

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa campaign enroll

Enroll one phone in a running or paused continuous drip (beta). Existing enrollments never restart.

### Usage

```bash
polymorfa campaign enroll CAMPAIGN [flags]
```

### Arguments

- `CAMPAIGN` (required). Campaign ID.

### Flags

- `--phone <value>` (value, required). International phone number.
- `--project-slug <value>` (value, required). Owning project slug.
- `--variables <value>` (value). Variables JSON file or stdin (-).

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa campaign launch

Request immediate or scheduled campaign launch.

### Usage

```bash
polymorfa campaign launch CAMPAIGN [flags]
```

### Arguments

- `CAMPAIGN` (required). Campaign ID.

### Flags

- `--idempotency-key <value>` (value). Idempotency-Key header. Generated per invocation when omitted; reuse an explicit key across process retries (24-hour retention).
- `--project-slug <value>` (value, required). Project slug in the Messaging API path.
- `--scheduled-at <value>` (value). Launch time as epoch milliseconds or an ISO 8601 instant.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa campaign list

List the complete newest-first campaign array for one project.

### Usage

```bash
polymorfa campaign list [flags]
```

### Flags

- `--project-slug <value>` (value, required). Project slug in the Messaging API path.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa campaign pause

Request that a running campaign pause.

### Usage

```bash
polymorfa campaign pause CAMPAIGN [flags]
```

### Arguments

- `CAMPAIGN` (required). Campaign ID.

### Flags

- `--idempotency-key <value>` (value). Deduplicate this request for 24 hours. A completed key returns 409 idempotency_completed.
- `--project-slug <value>` (value, required). Project slug in the Messaging API path.

Also accepts the [global flags](https://docs.polymorfa.com/cli#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

```bash
polymorfa campaign recipients add CAMPAIGN [flags]
```

### Arguments

- `CAMPAIGN` (required). Campaign ID.

### Flags

- `--csv <value>` (value). Read recipients from this spreadsheet and send them inline.
- `--idempotency-key <value>` (value). Send this Idempotency-Key header. The API does not replay appends, so the request is sent once and not retried.
- `--input <value>` (value). Read a JSON array of {phone, variables} from a file or stdin (-).
- `--phone-column <value>` (value). Header naming the phone column. Defaults to phone.
- `--project-slug <value>` (value, required). Project slug in the Messaging API path.
- `--variable <value>` (value, repeatable). Map a template variable to a column, as name=column. Repeatable; quote a column name that contains spaces.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

### Examples

```bash
polymorfa campaign recipients add 018f0000-0000-7000-8000-000000000001 --project-slug launch --csv contacts.csv --variable firstName="First name"
```

```bash
polymorfa campaign recipients add 018f0000-0000-7000-8000-000000000001 --project-slug launch --input recipients.json
```

## polymorfa campaign recipients list

List one page of a campaign’s recipients in queue order.

### Usage

```bash
polymorfa campaign recipients list CAMPAIGN [flags]
```

### Arguments

- `CAMPAIGN` (required). Campaign ID.

### Flags

- `--cursor <value>` (value). Continue from this opaque cursor.
- `--limit <value>` (value). Request this many recipients. The API defaults to 25.
- `--project-slug <value>` (value, required). Project slug in the Messaging API path.
- `--reason <value>` (value). Filter by recipient failure reason, including frequency_cap.
- `--status <value>` (value). Filter by delivery status. Use skipped to find recipients suppressed by an opt-out. Values: `queued`, `sending`, `sent`, `delivered`, `read`, `failed`, `skipped`.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

### Examples

```bash
polymorfa campaign recipients list 018f0000-0000-7000-8000-000000000001 --project-slug launch --status skipped
```

## polymorfa campaign requeue

Requeue failed recipients and optionally skipped recipients with errors.

### Usage

```bash
polymorfa campaign requeue CAMPAIGN [flags]
```

### Arguments

- `CAMPAIGN` (required). Campaign ID.

### Flags

- `--idempotency-key <value>` (value). Send this request identity without replay protection. A retry can requeue newly failed recipients.
- `--include-skipped-error` (boolean). Also requeue recipients skipped with an error.
- `--project-slug <value>` (value, required). Project slug in the Messaging API path.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa campaign resume

Request that a paused campaign resume.

### Usage

```bash
polymorfa campaign resume CAMPAIGN [flags]
```

### Arguments

- `CAMPAIGN` (required). Campaign ID.

### Flags

- `--idempotency-key <value>` (value). Deduplicate this request for 24 hours. A completed key returns 409 idempotency_completed.
- `--project-slug <value>` (value, required). Project slug in the Messaging API path.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa campaign segments count

Count audience segments (team key; beta gates and observed revisions apply).

### Usage

```bash
polymorfa campaign segments count [SEGMENT] [flags]
```

### Arguments

- `SEGMENT` (optional). Saved segment ID.

### Flags

- `--input <value>` (value). Unsaved rules object from JSON file or stdin (-). Use instead of a segment ID.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa campaign segments create

Create audience segments (team key; beta gates and observed revisions apply).

### Usage

```bash
polymorfa campaign segments create [flags]
```

### Flags

- `--input <value>` (value, required). JSON object from file or stdin (-). Update includes expectedRevision.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa campaign segments delete

Delete audience segments (team key; beta gates and observed revisions apply).

### Usage

```bash
polymorfa campaign segments delete SEGMENT [flags]
```

### Arguments

- `SEGMENT` (required). Saved segment ID.

### Flags

- `--revision <value>` (value, required). Observed segment revision.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa campaign segments get

Get audience segments (team key; beta gates and observed revisions apply).

### Usage

```bash
polymorfa campaign segments get SEGMENT [flags]
```

### Arguments

- `SEGMENT` (required). Saved segment ID.

### Flags

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa campaign segments list

List audience segments (team key; beta gates and observed revisions apply).

### Usage

```bash
polymorfa campaign segments list [flags]
```

### Flags

- `--cursor <value>` (value). Next page cursor.
- `--limit <value>` (value). Page size (1-100).

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa campaign segments update

Update audience segments (team key; beta gates and observed revisions apply).

### Usage

```bash
polymorfa campaign segments update SEGMENT [flags]
```

### Arguments

- `SEGMENT` (required). Saved segment ID.

### Flags

- `--input <value>` (value, required). JSON object from file or stdin (-). Update includes expectedRevision.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa campaign settings frequency-cap get

Read team contact frequency caps and their revision.

### Usage

```bash
polymorfa campaign settings frequency-cap get [flags]
```

### Flags

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa campaign settings frequency-cap remove

Remove both team limits, including without beta access. Requires the last read revision.

### Usage

```bash
polymorfa campaign settings frequency-cap remove [flags]
```

### Flags

- `--revision <value>` (value, required). Revision from get. On 409, read again and reconcile before retrying.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa campaign settings frequency-cap set

Replace team limits (beta). Omitted windows become unlimited. Stale revisions return 409; no automatic retry.

### Usage

```bash
polymorfa campaign settings frequency-cap set [flags]
```

### Flags

- `--max-per-24-hours <value>` (value). Rolling 24-hour limit; omitted means no limit.
- `--max-per-7-days <value>` (value). Rolling 7-day limit; omitted means no limit.
- `--revision <value>` (value, required). Revision from get. On 409, read again and reconcile before retrying.

Also accepts the [global flags](https://docs.polymorfa.com/cli#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

```bash
polymorfa campaign stop CAMPAIGN [flags]
```

### Arguments

- `CAMPAIGN` (required). Campaign ID.

### Flags

- `--idempotency-key <value>` (value). Deduplicate this request for 24 hours. A completed key returns 409 idempotency_completed.
- `--project-slug <value>` (value, required). Project slug in the Messaging API path.
- `--yes` (boolean, required). Confirm this terminal campaign transition.

Also accepts the [global flags](https://docs.polymorfa.com/cli#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

```bash
polymorfa campaign update CAMPAIGN [flags]
```

### Arguments

- `CAMPAIGN` (required). Campaign ID.

### Flags

- `--drip` (boolean). Enable drip sequences (beta).
- `--drip-enrollment <value>` (value). Drip enrollment mode. Audience closes continuous enrollment. Values: `audience`, `continuous`.
- `--drip-exit-on-link-click` (boolean). Stop remaining steps on tracked-link GET, including preview/scanner GETs.
- `--drip-exit-on-reply` (boolean). Stop remaining steps after a reply.
- `--frequency-cap-24-hours <value>` (value). Per-contact rolling 24-hour limit (beta).
- `--frequency-cap-7-days <value>` (value). Per-contact rolling 7-day limit (beta).
- `--input <value>` (value). Changes from JSON file or stdin (-).
- `--project-id <value>` (value). Owning project ID (Platform content and settings).
- `--project-slug <value>` (value). Owning project slug (Messaging settings).
- `--remove-drip` (boolean). Remove drip settings from an unlaunched draft.
- `--remove-frequency-cap` (boolean). Remove the campaign cap; the team cap still applies.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).

## polymorfa campaign view

View one campaign.

### Usage

```bash
polymorfa campaign view CAMPAIGN [flags]
```

### Arguments

- `CAMPAIGN` (required). Campaign ID.

### Flags

- `--project-slug <value>` (value, required). Project slug in the Messaging API path.

Also accepts the [global flags](https://docs.polymorfa.com/cli#global-flags).
