.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mail::Chimp3 3pm"
.TH Mail::Chimp3 3pm "2019-11-26" "perl v5.30.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Mail::Chimp3 \- An interface to mailchimp.com's RESTful Web API v3 using WEB::API
.SH "VERSION"
.IX Header "VERSION"
version 0.08
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
This is for the MailChimp \s-1API\s0 v3.0.
.PP
Please refer to the \s-1API\s0 documentation at
.PP
.Vb 1
\& use Mail::Chimp3;
\&
\& my $mailchimp = Mail::Chimp3\->new(
\& api_key => $apikey,
\& );
\&
\& my $response = $mailchimp\->add_store(
\& store_id => \*(Aq123\*(Aq,
\& cart_id => \*(Aq456\*(Aq,
\& );
.Ve
.SH "METHODS"
.IX Header "METHODS"
.IP "abuse_report" 4
.IX Item "abuse_report"
.PD 0
.IP "abuse_reports" 4
.IX Item "abuse_reports"
.IP "add_authorized_app" 4
.IX Item "add_authorized_app"
.IP "add_automation_subscriber" 4
.IX Item "add_automation_subscriber"
.IP "add_batch" 4
.IX Item "add_batch"
.IP "add_batch_webhook" 4
.IX Item "add_batch_webhook"
.IP "add_campaign" 4
.IX Item "add_campaign"
.IP "add_campaign_feedback" 4
.IX Item "add_campaign_feedback"
.IP "add_campaign_folder" 4
.IX Item "add_campaign_folder"
.IP "add_cart" 4
.IX Item "add_cart"
.IP "add_cart_line" 4
.IX Item "add_cart_line"
.IP "add_connected_site" 4
.IX Item "add_connected_site"
.IP "add_conversation_message" 4
.IX Item "add_conversation_message"
.IP "add_customer" 4
.IX Item "add_customer"
.IP "add_domain_name" 4
.IX Item "add_domain_name"
.IP "add_file_manager_file" 4
.IX Item "add_file_manager_file"
.IP "add_file_manager_folder" 4
.IX Item "add_file_manager_folder"
.IP "add_interest" 4
.IX Item "add_interest"
.IP "add_interest_category" 4
.IX Item "add_interest_category"
.IP "add_landing_page" 4
.IX Item "add_landing_page"
.IP "add_list" 4
.IX Item "add_list"
.IP "add_member" 4
.IX Item "add_member"
.IP "add_member_note" 4
.IX Item "add_member_note"
.IP "add_member_tag" 4
.IX Item "add_member_tag"
.IP "add_merge_field" 4
.IX Item "add_merge_field"
.IP "add_order" 4
.IX Item "add_order"
.IP "add_order_line" 4
.IX Item "add_order_line"
.IP "add_product" 4
.IX Item "add_product"
.IP "add_segment" 4
.IX Item "add_segment"
.IP "add_segment_member" 4
.IX Item "add_segment_member"
.IP "add_store" 4
.IX Item "add_store"
.IP "add_template" 4
.IX Item "add_template"
.IP "add_template_folder" 4
.IX Item "add_template_folder"
.IP "add_twitter_card" 4
.IX Item "add_twitter_card"
.IP "add_variant" 4
.IX Item "add_variant"
.IP "add_webhook" 4
.IX Item "add_webhook"
.IP "advice" 4
.IX Item "advice"
.IP "authorized_app" 4
.IX Item "authorized_app"
.IP "authorized_apps" 4
.IX Item "authorized_apps"
.IP "automation" 4
.IX Item "automation"
.IP "automation_email" 4
.IX Item "automation_email"
.IP "automation_emails" 4
.IX Item "automation_emails"
.IP "automation_subscriber" 4
.IX Item "automation_subscriber"
.IP "automation_subscribers" 4
.IX Item "automation_subscribers"
.IP "automations" 4
.IX Item "automations"
.IP "batch" 4
.IX Item "batch"
.IP "batches" 4
.IX Item "batches"
.IP "batch_list" 4
.IX Item "batch_list"
.IP "batch_segment" 4
.IX Item "batch_segment"
.IP "batch_webhooks" 4
.IX Item "batch_webhooks"
.IP "batch_webhook" 4
.IX Item "batch_webhook"
.IP "campaign" 4
.IX Item "campaign"
.IP "campaign_content" 4
.IX Item "campaign_content"
.IP "campaign_feedback" 4
.IX Item "campaign_feedback"
.IP "campaign_feedbacks" 4
.IX Item "campaign_feedbacks"
.IP "campaign_folder" 4
.IX Item "campaign_folder"
.IP "campaign_folders" 4
.IX Item "campaign_folders"
.IP "campaign_send_checklist" 4
.IX Item "campaign_send_checklist"
.IP "campaigns" 4
.IX Item "campaigns"
.IP "cancel_campaign" 4
.IX Item "cancel_campaign"
.IP "cart" 4
.IX Item "cart"
.IP "cart_line" 4
.IX Item "cart_line"
.IP "cart_lines" 4
.IX Item "cart_lines"
.IP "carts" 4
.IX Item "carts"
.IP "click_detail" 4
.IX Item "click_detail"
.IP "click_details" 4
.IX Item "click_details"
.IP "click_details_member" 4
.IX Item "click_details_member"
.IP "click_details_members" 4
.IX Item "click_details_members"
.IP "connected_sites" 4
.IX Item "connected_sites"
.IP "connected_site" 4
.IX Item "connected_site"
.IP "conversation" 4
.IX Item "conversation"
.IP "conversation_message" 4
.IX Item "conversation_message"
.IP "conversation_messages" 4
.IX Item "conversation_messages"
.IP "conversations" 4
.IX Item "conversations"
.IP "customer" 4
.IX Item "customer"
.IP "customers" 4
.IX Item "customers"
.IP "delete_batch" 4
.IX Item "delete_batch"
.IP "delete_batch_webhook" 4
.IX Item "delete_batch_webhook"
.IP "delete_campaign" 4
.IX Item "delete_campaign"
.IP "delete_campaign_feedback" 4
.IX Item "delete_campaign_feedback"
.IP "delete_campaign_folder" 4
.IX Item "delete_campaign_folder"
.IP "delete_cart" 4
.IX Item "delete_cart"
.IP "delete_cart_line" 4
.IX Item "delete_cart_line"
.IP "delete_connected_site" 4
.IX Item "delete_connected_site"
.IP "delete_customer" 4
.IX Item "delete_customer"
.IP "delete_domain_name" 4
.IX Item "delete_domain_name"
.IP "delete_file_manager_file" 4
.IX Item "delete_file_manager_file"
.IP "delete_file_manager_folder" 4
.IX Item "delete_file_manager_folder"
.IP "delete_interest" 4
.IX Item "delete_interest"
.IP "delete_interest_category" 4
.IX Item "delete_interest_category"
.IP "delete_landing_page" 4
.IX Item "delete_landing_page"
.IP "delete_list" 4
.IX Item "delete_list"
.IP "delete_member" 4
.IX Item "delete_member"
.IP "delete_member_note" 4
.IX Item "delete_member_note"
.IP "delete_merge_field" 4
.IX Item "delete_merge_field"
.IP "delete_order" 4
.IX Item "delete_order"
.IP "delete_order_line" 4
.IX Item "delete_order_line"
.IP "delete_product" 4
.IX Item "delete_product"
.IP "delete_segment" 4
.IX Item "delete_segment"
.IP "delete_segment_member" 4
.IX Item "delete_segment_member"
.IP "delete_store" 4
.IX Item "delete_store"
.IP "delete_template" 4
.IX Item "delete_template"
.IP "delete_template_folder" 4
.IX Item "delete_template_folder"
.IP "delete_variant" 4
.IX Item "delete_variant"
.IP "delete_webhook" 4
.IX Item "delete_webhook"
.IP "domain_performance" 4
.IX Item "domain_performance"
.IP "eepurl" 4
.IX Item "eepurl"
.IP "email_activity" 4
.IX Item "email_activity"
.IP "facebook_ad" 4
.IX Item "facebook_ad"
.IP "facebook_ads" 4
.IX Item "facebook_ads"
.IP "file_manager_file" 4
.IX Item "file_manager_file"
.IP "file_manager_files" 4
.IX Item "file_manager_files"
.IP "file_manager_folder" 4
.IX Item "file_manager_folder"
.IP "file_manager_folders" 4
.IX Item "file_manager_folders"
.IP "growth_history" 4
.IX Item "growth_history"
.IP "growth_history_month" 4
.IX Item "growth_history_month"
.IP "google_ads" 4
.IX Item "google_ads"
.IP "google_ads_instance" 4
.IX Item "google_ads_instance"
.IP "interest" 4
.IX Item "interest"
.IP "interest_categories" 4
.IX Item "interest_categories"
.IP "interest_category" 4
.IX Item "interest_category"
.IP "interests" 4
.IX Item "interests"
.IP "landing_page" 4
.IX Item "landing_page"
.IP "landing_page_content" 4
.IX Item "landing_page_content"
.IP "landing_pages" 4
.IX Item "landing_pages"
.IP "list" 4
.IX Item "list"
.IP "list_activity" 4
.IX Item "list_activity"
.IP "list_clients" 4
.IX Item "list_clients"
.IP "lists" 4
.IX Item "lists"
.IP "locations" 4
.IX Item "locations"
.IP "member" 4
.IX Item "member"
.IP "member_activity" 4
.IX Item "member_activity"
.IP "member_email_activity" 4
.IX Item "member_email_activity"
.IP "member_goals" 4
.IX Item "member_goals"
.IP "member_note" 4
.IX Item "member_note"
.IP "member_notes" 4
.IX Item "member_notes"
.IP "member_tags" 4
.IX Item "member_tags"
.IP "member_sent_to" 4
.IX Item "member_sent_to"
.IP "member_unsubscribed" 4
.IX Item "member_unsubscribed"
.IP "members" 4
.IX Item "members"
.IP "merge_field" 4
.IX Item "merge_field"
.IP "merge_fields" 4
.IX Item "merge_fields"
.IP "order" 4
.IX Item "order"
.IP "order_line" 4
.IX Item "order_line"
.IP "order_lines" 4
.IX Item "order_lines"
.IP "orders" 4
.IX Item "orders"
.IP "pause_automation" 4
.IX Item "pause_automation"
.IP "pause_automation_email" 4
.IX Item "pause_automation_email"
.IP "pause_campaign" 4
.IX Item "pause_campaign"
.IP "ping" 4
.IX Item "ping"
.IP "product" 4
.IX Item "product"
.IP "products" 4
.IX Item "products"
.IP "publish_landing_page" 4
.IX Item "publish_landing_page"
.IP "remove_automation_subscriber" 4
.IX Item "remove_automation_subscriber"
.IP "removed_automation_subscribers" 4
.IX Item "removed_automation_subscribers"
.IP "replicate_campaign" 4
.IX Item "replicate_campaign"
.IP "report" 4
.IX Item "report"
.IP "reports" 4
.IX Item "reports"
.IP "reporting" 4
.IX Item "reporting"
.IP "reporting_facebook_ad" 4
.IX Item "reporting_facebook_ad"
.IP "reporting_facebook_ad_ecommerce" 4
.IX Item "reporting_facebook_ad_ecommerce"
.IP "reporting_facebook_ads" 4
.IX Item "reporting_facebook_ads"
.IP "reporting_google_ad" 4
.IX Item "reporting_google_ad"
.IP "reporting_google_ad_ecommerce" 4
.IX Item "reporting_google_ad_ecommerce"
.IP "reporting_google_ads" 4
.IX Item "reporting_google_ads"
.IP "reporting_landing_page" 4
.IX Item "reporting_landing_page"
.IP "reporting_landing_pages" 4
.IX Item "reporting_landing_pages"
.IP "resume_campaign" 4
.IX Item "resume_campaign"
.IP "root" 4
.IX Item "root"
.IP "schedule_campaign" 4
.IX Item "schedule_campaign"
.IP "search_campaigns" 4
.IX Item "search_campaigns"
.IP "search_members" 4
.IX Item "search_members"
.IP "segment" 4
.IX Item "segment"
.IP "segment_members" 4
.IX Item "segment_members"
.IP "segments" 4
.IX Item "segments"
.IP "send_campaign" 4
.IX Item "send_campaign"
.IP "sent_to" 4
.IX Item "sent_to"
.IP "set_campaign_content" 4
.IX Item "set_campaign_content"
.IP "start_automation" 4
.IX Item "start_automation"
.IP "start_automation_email" 4
.IX Item "start_automation_email"
.IP "store" 4
.IX Item "store"
.IP "stores" 4
.IX Item "stores"
.IP "sub_reports" 4
.IX Item "sub_reports"
.IP "template" 4
.IX Item "template"
.IP "template_default_content" 4
.IX Item "template_default_content"
.IP "template_folder" 4
.IX Item "template_folder"
.IP "template_folders" 4
.IX Item "template_folders"
.IP "templates" 4
.IX Item "templates"
.IP "test_campaign" 4
.IX Item "test_campaign"
.IP "twitter_card" 4
.IX Item "twitter_card"
.IP "twitter_cards" 4
.IX Item "twitter_cards"
.IP "unpublish_landing_page" 4
.IX Item "unpublish_landing_page"
.IP "unschedule_campaign" 4
.IX Item "unschedule_campaign"
.IP "unsubscribed" 4
.IX Item "unsubscribed"
.IP "update_batch_webhook" 4
.IX Item "update_batch_webhook"
.IP "update_campaign" 4
.IX Item "update_campaign"
.IP "update_campaign_feedback" 4
.IX Item "update_campaign_feedback"
.IP "update_campaign_folder" 4
.IX Item "update_campaign_folder"
.IP "update_cart" 4
.IX Item "update_cart"
.IP "update_cart_line" 4
.IX Item "update_cart_line"
.IP "update_customer" 4
.IX Item "update_customer"
.IP "update_file_manager_file" 4
.IX Item "update_file_manager_file"
.IP "update_file_manager_folder" 4
.IX Item "update_file_manager_folder"
.IP "update_interest" 4
.IX Item "update_interest"
.IP "update_interest_category" 4
.IX Item "update_interest_category"
.IP "update_landing_page" 4
.IX Item "update_landing_page"
.IP "update_list" 4
.IX Item "update_list"
.IP "update_member" 4
.IX Item "update_member"
.IP "update_member_note" 4
.IX Item "update_member_note"
.IP "update_merge_field" 4
.IX Item "update_merge_field"
.IP "update_order" 4
.IX Item "update_order"
.IP "update_order_line" 4
.IX Item "update_order_line"
.IP "update_product" 4
.IX Item "update_product"
.IP "update_segment" 4
.IX Item "update_segment"
.IP "update_store" 4
.IX Item "update_store"
.IP "update_template" 4
.IX Item "update_template"
.IP "update_template_folder" 4
.IX Item "update_template_folder"
.IP "update_variant" 4
.IX Item "update_variant"
.IP "upsert_customer" 4
.IX Item "upsert_customer"
.IP "upsert_member" 4
.IX Item "upsert_member"
.IP "upsert_variant" 4
.IX Item "upsert_variant"
.IP "variant" 4
.IX Item "variant"
.IP "variants" 4
.IX Item "variants"
.IP "verified_domains" 4
.IX Item "verified_domains"
.IP "verified_domain_name" 4
.IX Item "verified_domain_name"
.IP "verify_connected_site" 4
.IX Item "verify_connected_site"
.IP "verify_domain_name" 4
.IX Item "verify_domain_name"
.IP "webhook" 4
.IX Item "webhook"
.IP "webhooks" 4
.IX Item "webhooks"
.PD
.SH "INTERNALS"
.IX Header "INTERNALS"
.IP "commands" 4
.IX Item "commands"
Required by Web::API
.SS "\s-1BUILD\s0"
.IX Subsection "BUILD"
basic configuration for the client \s-1API\s0 happens usually in the \s-1BUILD\s0 method when using Web::API
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on GitHub's issue tracker .
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\& perldoc Mail::Chimp3
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
GitHub repository
.Sp
.SH "CONTRIBUTORS"
.IX Header "CONTRIBUTORS"
Peter Karman (pkarman)
.SH "AUTHOR"
.IX Header "AUTHOR"
Josh Lavin
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2016 by Josh Lavin.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.