Skip to content

campaigns

konigle.cli.comm.campaigns

CLI commands for campaign management operations.

add_campaign_ltv(ctx, campaign_id, contact_email, value, currency)

Add LTV (Lifetime Value) to a campaign from a purchase.

campaigns()

Campaign management commands.

cancel_campaign(ctx, campaign_id, yes)

Cancel a campaign (works when running, draft, or scheduled).

create_campaign(ctx, name, audience, email_channel, email_template, description, scheduled_at, execution_duration, from_email, from_name, reply_to_email, reply_to_name, utm_code)

Create a new campaign.

delete_campaign(ctx, campaign_id, yes)

Delete a campaign.

get_campaign(ctx, campaign_id)

Get a campaign by ID with execution details.

list_campaigns(ctx, page, page_size, search, status, audience)

List campaigns.

new_email_campaign(ctx, name, email_channel, tags, subject, body_html, body_text, description, utm_code, from_email, from_name, reply_to_email, reply_to_name, scheduled_at, execution_duration, audience_name, template_name)

Create a new email campaign with audience and template in one step.

pause_campaign(ctx, campaign_id)

Pause a running campaign.

resume_campaign(ctx, campaign_id)

Resume a paused campaign.

schedule_campaign(ctx, campaign_id, scheduled_at)

Schedule or reschedule a campaign.

send_test_email(ctx, campaign_id, email_address)

Send a test email for the specified email campaign.

start_campaign(ctx, campaign_id)

Start a campaign (only works when status is draft or scheduled).

update_campaign(ctx, campaign_id, name, description, audience, email_channel, email_template, scheduled_at, execution_duration, from_email, from_name, reply_to_email, reply_to_name, utm_code)

Update a campaign.