View Source Mailchimp.Campaign (mailchimp v0.2.0)

Campaigns are how you send emails to your Mailchimp list. Use the Campaigns API calls to manage campaigns in your Mailchimp account.

struct-fields

Struct Fields

  • id - A string that uniquely identifies this campaign.

  • web_id - The ID used in the Mailchimp web application. View this campaign in your Mailchimp account at https://{dc}.admin.mailchimp.com/campaigns/show/?id={web_id}.

  • type - There are four types of campaigns you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead. Possible values: "regular", "plaintext", "absplit", "rss", or "variate".

  • create_time - The date and time the campaign was created in ISO 8601 format.

  • archive_url - The link to the campaign's archive version in ISO 8601 format.

  • long_archive_url - The original link to the campaign's archive version.

  • status - The current status of the campaign. Possible values: "save", "paused", "schedule", "sending", "sent", "canceled", "canceling", or "archived".

  • emails_sent - The total number of emails sent for this campaign.

  • send_time - The date and time a campaign was sent.

  • content_type - How the campaign's content is put together. Possible values: "template", "html", "url", or "multichannel".

  • recipients - List settings for the campaign.

  • settings - The settings for your campaign, including subject, from name, reply-to address, and more.

  • variate_settings - The settings specific to A/B test campaigns.

  • tracking - The tracking options for a campaign.

  • rss_opts - RSS options for a campaign.

  • ab_split_opts - A/B Testing options for a campaign.

  • social_card - The preview for the campaign, rendered by social networks like Facebook and Twitter. Learn more.

  • report_summary - For sent campaigns, a summary of opens, clicks, and e-commerce data.

  • delivery_status - Updates on campaigns in the process of sending.

Link to this section Summary

Functions

Same as content/1 but raises errors.

Fetches the Mailchimp.Campaign.Content for a given campaing

Same as create/2 but raises errors.

Creates a Mailchimp.Campaign with additional fields for attributes and sends it to mailchimp

Same as list/1 but raises errors.

Creates an empty list

Fetch campaigns with query params

Generates an Mailchimp.Campaign struct from the given attributes.

Link to this section Functions

Same as content/1 but raises errors.

Fetches the Mailchimp.Campaign.Content for a given campaing

Link to this function

create!(type, attrs \\ %{})

View Source

Same as create/2 but raises errors.

Link to this function

create(type, attrs \\ %{})

View Source

Creates a Mailchimp.Campaign with additional fields for attributes and sends it to mailchimp

Link to this function

list!(query_params \\ %{})

View Source

Same as list/1 but raises errors.

Creates an empty list

Fetch campaigns with query params

Generates an Mailchimp.Campaign struct from the given attributes.