Mailchimp

Writes

• Upsert member

  read back

  mailchimp-upsert-member

  Add one person to an audience, or update their name if they are already in it. A new member gets status_if_new; an existing member keeps their status, so this never changes someone's consent (use set-member-status for that). subscribed adds them without a confirmation email; pending sends Mailchimp's opt-in email; transactional receives no campaigns.

• Update member name

  read back

  mailchimp-update-member-name

  Replace one member's first and last name.

• Set member status

  read back

  mailchimp-set-member-status

  Change one member's subscription status: unsubscribed stops campaigns to them; pending sends Mailchimp's opt-in email; subscribed adds them back without one. This is the person's consent, so do it on their request.

• Add member tag

  read back

  mailchimp-add-member-tag

  Add one tag to a member. A tag that does not exist yet is created.

• Remove member tag

  read back

  mailchimp-remove-member-tag

  Remove one tag from a member. The tag stays in the audience.

• Add member note

  read back

  mailchimp-add-member-note

  Add one note to a member, up to 1,000 characters. Notes are internal; the member never sees them.

• Archive member

  read back

  mailchimp-archive-member

  Archive one member: they leave the audience and receive nothing more, and their history is kept. Adding them again with upsert-member brings them back.

• Add to segment

  read back

  mailchimp-add-to-segment

  Add one member, by email address, to a static segment or tag.

• Remove from segment

  read back

  mailchimp-remove-from-segment

  Remove one member from a static segment or tag. The member stays in the audience.

• Send test email

  acknowledged

  mailchimp-send-test-email

  Send a test of one campaign to the addresses given, as HTML or plain text. The campaign itself is not sent. Counted in emails, one per address.

• Schedule campaign

  read back

  mailchimp-schedule-campaign

  Schedule one draft campaign to go to its whole audience at a UTC time on the quarter hour. This is a send to many people; check recipients.recipient_count with get-campaign first.

• Unschedule campaign

  read back

  mailchimp-unschedule-campaign

  Unschedule one scheduled campaign, so it goes back to a draft and is not sent.

Reads

• List audiences

  mailchimp-list-audiences

  List the account's audiences (Mailchimp's lists): id, name, created date, and member and unsubscribe counts. 20 a page; total_items gives the total, and offset pages on.

• Get audience

  mailchimp-get-audience

  Get one audience by id: name, contact details, campaign defaults, permission reminder, subscribe URL and stats.

• Search members

  mailchimp-search-members

  Find members by email address or by first or last name, in one audience or all of them: id, email, name, status and audience. Mailchimp answers exact matches and a fuller search in one response, with no next page.

• List members

  mailchimp-list-members

  List an audience's members, most recently changed first: id, email, name, status, tags and when they last changed. 20 a page; filter by status. total_items gives the total, and offset pages on.

• Get member

  mailchimp-get-member

  Get one member of an audience by email address or member id: status, name and merge fields, tags (up to 50), language, VIP, location, stats and when they opted in.

• List member tags

  mailchimp-list-member-tags

  List the tags on one member, with each tag's id, name and when it was added. 50 a page; total_items gives the total, and offset pages on.

• List member notes

  mailchimp-list-member-notes

  List the notes on one member, newest first: id, text, author and dates. 10 a page; total_items gives the total, and offset pages on.

• Get member activity

  mailchimp-get-member-activity

  Get one member's recent activity, newest first: opens, clicks, bounces, sign-ups, notes and other events, each with its type and date. 20 a page; filter by activity type; offset pages on.

• List segments

  mailchimp-list-segments

  List an audience's segments and tags (a tag is a static segment): id, name, type and member count. 20 a page; filter by type; total_items gives the total, and offset pages on.

• List segment members

  mailchimp-list-segment-members

  List the members of one segment or tag: id, email, name and status. 20 a page; total_items gives the total, and offset pages on.

• List campaigns

  mailchimp-list-campaigns

  List campaigns, newest first: id, type, status, title, subject line, audience, recipient count, emails sent and send time. 10 a page; filter by status or audience; total_items gives the total, and offset pages on.

• Get campaign

  mailchimp-get-campaign

  Get one campaign by id: status, settings (title, subject, from name, reply-to), recipients (audience, segment and recipient count), tracking, send time and a report summary once sent.