Method: Mailchimp::Lists#member_info

Defined in:: lib/mailchimp/api.rb

#member_info(id, emails) ⇒ `Hash`

Get all the information for particular members of a list

Parameters:

id (String) —

the list id to connect to. Get by calling lists/list()
emails (Array) —
an array of up to 50 email structs, each with with one of the following keys
- String
  
  email an email address - for new subscribers obviously this should be used
- String
  
  euid the unique id for an email address (not list related) - the email “id” returned from listMemberInfo, Webhooks, Campaigns, etc.
- String
  
  leid the list email id (previously called web_id) for a list-member-info type call. this doesn’t change when the email address changes

Returns:

(Hash) —

of data and success/error counts

Int

success_count the number of subscribers successfully found on the list
Int

error_count the number of subscribers who were not found on the list

Array: errors array of error structs including:

- [Hash] email whatever was passed in the email parameter
    - [String] email the email address added
    - [String] euid the email unique id
    - [String] leid the list member's truly unique id
- [String] error the error message

Array: data array of structs for each valid list member

- [String] id The unique id (euid) for this email address on an account
- [String] email The email address associated with this record
- [String] email_type The type of emails this customer asked to get: html or text
- [Hash] merges a struct containing a key for each merge tags and the data for those tags for this email address, plus:
    - [Array] GROUPINGS if Interest groupings are enabled, this will exist with structs for each grouping:
        - [Int] id the grouping id
        - [String] name the interest group name
        - [Array] groups structs for each group in the grouping
            - [String] name the group name
            - [Bool] interested whether the member has this group selected
- [String] status The subscription status for this email address, either pending, subscribed, unsubscribed, or cleaned
- [String] ip_signup IP Address this address signed up from. This may be blank if single optin is used.
- [String] timestamp_signup The date+time the double optin was initiated. This may be blank if single optin is used.
- [String] ip_opt IP Address this address opted in from.
- [String] timestamp_opt The date+time the optin completed
- [Int] member_rating the rating of the subscriber. This will be 1 - 5 as described <a href="http://eepurl.com/f-2P" target="_blank">here</a>
- [String] campaign_id If the user is unsubscribed and they unsubscribed from a specific campaign, that campaign_id will be listed, otherwise this is not returned.
- [Array] lists An array of structs for the other lists this member belongs to
    - [String] id the list id
    - [String] status the members status on that list
- [String] timestamp The date+time this email address entered it's current status
- [String] info_changed The last time this record was changed. If the record is old enough, this may be blank.
- [Int] web_id The Member id used in our web app, allows you to create a link directly to it
- [Int] leid The Member id used in our web app, allows you to create a link directly to it
- [String] list_id The list id the for the member record being returned
- [String] list_name The list name the for the member record being returned
- [String] language if set/detected, a language code from <a href="http://kb.mailchimp.com/article/can-i-see-what-languages-my-subscribers-use#code" target="_blank">here</a>
- [Bool] is_gmonkey Whether the member is a <a href="http://mailchimp.com/features/golden-monkeys/" target="_blank">Golden Monkey</a> or not.
- [Hash] geo the geographic information if we have it. including:
    - [String] latitude the latitude
    - [String] longitude the longitude
    - [String] gmtoff GMT offset
    - [String] dstoff GMT offset during daylight savings (if DST not observered, will be same as gmtoff)
    - [String] timezone the timezone we've place them in
    - [String] cc 2 digit ISO-3166 country code
    - [String] region generally state, province, or similar
- [Hash] clients the client we've tracked the address as using with two keys:
    - [String] name the common name of the client
    - [String] icon_url a url representing a path to an icon representing this client
- [Array] static_segments structs for each static segments the member is a part of including:
    - [Int] id the segment id
    - [String] name the name given to the segment
    - [String] added the date the member was added
- [Array] notes structs for each note entered for this member. For each note:
    - [Int] id the note id
    - [String] note the text entered
    - [String] created the date the note was created
    - [String] updated the date the note was last updated
    - [String] created_by_name the name of the user who created the note. This can change as users update their profile.

# File 'lib/mailchimp/api.rb', line 872

def member_info(id, emails)
    _params = {:id => id, :emails => emails}
    return @master.call 'lists/member-info', _params
end

Method: Mailchimp::Lists#member_info

#member_info(id, emails) ⇒ Hash

#member_info(id, emails) ⇒ `Hash`