Klaviyo.Campaign (klaviyo v2.3.0)

Link to this section Summary

Functions

Return all campaigns.

Return summary details for all email recipients of a campaign.

Cancel a campaign that has been queued to send.

Create a copy of a campaign.

Create a campaign.

Retrieve a campaign summary.

Schedule a campaign to be sent sometime in the future.

Send a campaign immediately.

Update a campaign.

Link to this section Functions

Link to this function

all(params \\ %{})

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

Return all campaigns.

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

Link to this function

all_recipients(campaign_id, params \\ %{})

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

Return summary details for all email recipients of a campaign.

Link to this function

cancel(campaign_id)

@spec 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.

Link to this function

clone(campaign_id, params)

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

Create a copy of a campaign.

Campaigns are created as drafts.

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

Create a campaign.

Campaigns are created as drafts.

Link to this function

get(campaign_id)

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

Retrieve a campaign summary.

Link to this function

schedule(campaign_id, params)

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

Schedule a campaign to be sent sometime in the future.

Link to this function

send(campaign_id)

Send a campaign immediately.

Link to this function

update(campaign_id, params)

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

Update a campaign.