Pipeline settings from the CLI

Read, preview and save

akedly pipelines get <id>
akedly pipelines update <id> --status active --dry-run
akedly pipelines update <id> --status active --yes

Use a Full access CLI Login with permission to read and update the affected resources. --dry-run previews without consent or writes; it can still read the current settings, method catalog, attached widgets and recommendations. The server checks availability and validation on the real save.

The generated pipelines update reference lists every flag, allowed value, setting tip and consent rule. Flags use feature names, such as --otp-language ar and --smart-routing on.

Where settings are saved

The CLI uses the resulting API version if the command also changes it. V1/V2 changes that need a widget are refused when none is attached. To change just one widget, use widgets update.

When a command affects several resources, it reads their current revisions, saves the pipeline first, then saves widgets in creation-time/id order. This is a sequence of guarded saves, not one atomic save; see recovering an update.

Choose the setting

These groups cover the update flags. The linked reference carries their complete values, tips, defaults and restrictions.

Callback, behavior, security, version, branding and template changes require --yes; this includes turning protection off, loosening a limit, or supplying the current value. --period selects a recommendation window and does not itself change a setting. Creation uses the smaller pipelines create flag set; configure the remaining settings after creation.

Lists replace; files merge

• --verification-methods whatsapp,sms,email replaces every saved method. Each word appears once; email goes last. Use --method-order custom to use your listed phone-channel order. Automatic order starts with WhatsApp by default and uses eligible listed fallbacks; Channel Choice and Smart Routing can alter the first send.
• --cluster-gate-home-countries EG,SA replaces all declarations; omit it to preserve them or use none alone to clear them. Learned countries remain separate.
• --destination-countries EG,SA replaces the complete restriction list. Send the intended mode too; a changed list under all is refused.
• A rate-limit JSON file changes only its named limits. Omitted sibling values remain saved. Files must be regular JSON object files, at most 64 KiB.

{
  "perPipeline": { "perMinute": 30, "perHour": 150, "perDay": 3000 }
}

V1.2 files accept perPhoneNumber, perIpAddress and perPipeline, each with perMinute, perHour and perDay. Use whole numbers above zero. For V1/V2, use the widget file shape, even when running pipelines update.

Recovering an update

PIPELINE_CHANGED or WIDGET_CHANGED means another save won the race for that resource. Read the current settings and rerun the command so it plans from the new revision.

PARTIAL_UPDATE means some resources may already be saved. Inspect details.applied, details.notApplied and the underlying error, read the affected resources, then rerun the same update to finish the remaining work. An unconfirmed destination can have saved before the connection failed. Do not assume the whole command rolled back.

Revision-protected writes do not retry an uncertain network/server outcome automatically. The explicit CLI_RATE_LIMITED refusal can still be retried because it saved nothing. See settings errors for each refusal and its exit code.

Next: setup recipes, widget settings, or the complete pipeline reference.