Klaviyo.Campaign (klaviyo v2.1.1)

Link to this section Summary

Functions

all(params \\ %{})

Return all campaigns.

all_recipients(campaign_id, params \\ %{})

Return summary details for all email recipients of a campaign.

cancel(campaign_id)

Cancel a campaign that has been queued to send.

clone(campaign_id, params)

Create a copy of a campaign.

create(params)

Create a campaign.

get(campaign_id)

Retrieve a campaign summary.

schedule(campaign_id, params)

Schedule a campaign to be sent sometime in the future.

send(campaign_id)

Send a campaign immediately.

update(campaign_id, params)

Update a campaign.

Link to this section Functions

all(params \\ %{})

Specs

all(map()) :: Klaviyo.Operation.t()

Return all campaigns.

Campaigns are returned in reverse sorted order by the time they were created.

all_recipients(campaign_id, params \\ %{})

Specs

all_recipients(String.t(), map()) :: Klaviyo.Operation.t()

Return summary details for all email recipients of a campaign.

cancel(campaign_id)

Specs

cancel(String.t()) :: Klaviyo.Operation.t()

Cancel a campaign that has been queued to send.

Marks a campaign as cancelled regardless of it's current status.

clone(campaign_id, params)

Specs

clone(String.t(), map()) :: Klaviyo.Operation.t()

Create a copy of a campaign.

Campaigns are created as drafts.

create(params)

Specs

create(map()) :: Klaviyo.Operation.t()

Create a campaign.

Campaigns are created as drafts.

get(campaign_id)

Specs

get(String.t()) :: Klaviyo.Operation.t()

Retrieve a campaign summary.

schedule(campaign_id, params)

Specs

schedule(String.t(), map()) :: Klaviyo.Operation.t()

Schedule a campaign to be sent sometime in the future.

send(campaign_id)

Send a campaign immediately.

update(campaign_id, params)

Specs

update(String.t(), map()) :: Klaviyo.Operation.t()

Update a campaign.