View Source Mailchimp.List (mailchimp v0.2.0)
Your Mailchimp list, also known as your audience, is where you store and manage all of your contacts.
struct-fields
Struct Fields
id- A string that uniquely identifies this list.name- The name of the list.permission_reminder- The persmission reminder for the list.campaign_defaults- Default values for campaigns created for this list.notify_on_subscribe- The email address to send subscribe notifications to.notify_on_unsubscribe- The email address to send unsubscribe notifications to.list_rating- An auto-generated activity score for the list (0-5).email_type_option- Whether the list support multiple formats for emails. When set to true, subscribers can choose whether they want to receive HTML or plain-text emails. When set to false, subscribers will receive HTML emails, with a plain-text alternative backup.subscribe_url_short- url Link shortened version of this list's subscribe form.subscribe_url_long- The full version of this list's subscribe form (host will vary).beamer_address- The list's Email Beamer address.visibility- Legacy. visibility settings are no longer used Possible values: "pub" or "prv".modules- Any list-specific modules installed for this list.stats- Stats for the list. Many of these are cached for at least five minutes.links- A list ofMailchimp.Linktypes and descriptions for the API schema documents.
Link to this section Summary
Functions
Same as batch_subscribe
but raises errors.
Batch subscribe members. Pass the List and the list of members with properties such as email_address, status, and merge_fields (for example, for first and last name). Additional options can be passed, such as update_existing. See the API docs for details: https://mailchimp.com/developer/api/marketing/lists/batch-subscribe-or-unsubscribe/
Fetches all members on the mailchimp list, and compares then to the given list of members. Warning: This method only checks for the same email address
Same as create_member/5
but raises errors.
Creates a member at Mailchimp. You can pass merge_fields or additional_data
Same as create_members/5
but raises errors.
Creates a list of members at Mailchimp. You can pass merge_fields or additional_data
Same as create_or_update_member/5
but raises errors.
Creates or updates a member at Mailchimp. You can pass merge_fields or additional_data
Sends a request that removes a Mailchimp.Member of a given list by it's email
Same as get_member
but raises errors.
Fetches a Mailchimp.Member of a given list by it's email
Same as interest_categories
but raises errors.
Fetches a list of Mailchimp.List.InterestCategory of a given list
Same as members/2
but raises errors.
Fetches a list of Mailchimp.Member of a given list
Generates an Mailchimp.List struct from the given attributes.
Link to this section Functions
Same as batch_subscribe
but raises errors.
Batch subscribe members. Pass the List and the list of members with properties such as email_address, status, and merge_fields (for example, for first and last name). Additional options can be passed, such as update_existing. See the API docs for details: https://mailchimp.com/developer/api/marketing/lists/batch-subscribe-or-unsubscribe/
Fetches all members on the mailchimp list, and compares then to the given list of members. Warning: This method only checks for the same email address
Raises errors on connection failure
examples
Examples
iex> check_diff_to_mailchimp!(list,[member1])
%{members_on_mailchimp: [], members_not_on_mailchimp: []}create_member!(list, email_address, status, merge_fields \\ %{}, additional_data \\ %{})
View Source Same as create_member/5
but raises errors.
create_member(list, email_address, status, merge_fields \\ %{}, additional_data \\ %{})
View SourceCreates a member at Mailchimp. You can pass merge_fields or additional_data
create_members!(list, email_addresses, status, merge_fields \\ %{}, additional_data \\ %{})
View Source Same as create_members/5
but raises errors.
create_members(list, email_addresses, status, merge_fields \\ %{}, additional_data \\ %{})
View SourceCreates a list of members at Mailchimp. You can pass merge_fields or additional_data
create_or_update_member!(list, email_address, status_if_new, merge_fields \\ %{}, additional_data \\ %{})
View Source Same as create_or_update_member/5
but raises errors.
create_or_update_member(list, email_address, status_if_new, merge_fields \\ %{}, additional_data \\ %{})
View SourceCreates or updates a member at Mailchimp. You can pass merge_fields or additional_data
Sends a request that removes a Mailchimp.Member of a given list by it's email
Same as get_member
but raises errors.
Fetches a Mailchimp.Member of a given list by it's email
Same as interest_categories
but raises errors.
Fetches a list of Mailchimp.List.InterestCategory of a given list
Same as members/2
but raises errors.
Fetches a list of Mailchimp.Member of a given list
Generates an Mailchimp.List struct from the given attributes.