Module: MailchimpAPI::Audience::SegmentMembers::APIs

Includes:
Utils, Pagination::ListEachItemHelper
Included in:
MailchimpAPI::Audience::SegmentMembers, MailchimpAPI::Audience::SegmentMembers
Defined in:
lib/mailchimp-api/resources/audience/segment_members.rb

Overview

Module with endpoints for SegmentMembers APIs

Instance Method Summary collapse

Instance Method Details

#create(list_id, segment_id, query: nil, body: nil, headers: nil) ⇒ Response

Add a member to a static segment

Examples:

Add a member to a segment

segment_members.create('list123', 'segment456', body: {
  email_address: '[email protected]'
})

Parameters:

  • list_id (String) —

    The ID of the Mailchimp list

  • segment_id (String) —

    The ID of the segment

  • query (Hash) (defaults to: nil) —

    Optional query parameters

  • body (Hash) (defaults to: nil) —

    Member details

  • headers (Hash) (defaults to: nil) —

    Optional request headers

Returns:

  • (Response) —

    API response containing the added member



38
39
40
41
 
# File 'lib/mailchimp-api/resources/audience/segment_members.rb', line 38

def create(list_id, segment_id, query: nil, body: nil, headers: nil)
  path = "/lists/#{list_id}/segments/#{segment_id}/members"
  client.post(path, query: query, body: body, headers: headers)
end

#delete(list_id, segment_id, email, query: nil, body: nil, headers: nil) ⇒ Response

Remove a member from a static segment

Examples:

Remove a member from a segment

segment_members.delete('list123', 'segment456', '[email protected]')

Parameters:

  • list_id (String) —

    The ID of the Mailchimp list

  • segment_id (String) —

    The ID of the segment

  • email (String) —

    The email address of the member to remove

  • query (Hash) (defaults to: nil) —

    Optional query parameters

  • body (Hash) (defaults to: nil) —

    Optional request body

  • headers (Hash) (defaults to: nil) —

    Optional request headers

Returns:



53
54
55
56
 
# File 'lib/mailchimp-api/resources/audience/segment_members.rb', line 53

def delete(list_id, segment_id, email, query: nil, body: nil, headers: nil)
  path = "/lists/#{list_id}/segments/#{segment_id}/members/#{subscriber_hash(email)}"
  client.delete(path, query: query, body: body, headers: headers)
end

#each(list_id, segment_id, query: nil, body: nil, headers: nil) {|Hash| ... } ⇒ Object

Iterate through all members in a segment

Examples:

Iterate through segment members

segment_members.each('list123', 'segment456') do |member|
  puts member[:email_address]
end

Parameters:

  • list_id (String) —

    The ID of the Mailchimp list

  • segment_id (String) —

    The ID of the segment

  • query (Hash) (defaults to: nil) —

    Optional query parameters

  • body (Hash) (defaults to: nil) —

    Optional request body

  • headers (Hash) (defaults to: nil) —

    Optional request headers

Yields:

  • (Hash) —

    Each segment member



69
70
71
 
# File 'lib/mailchimp-api/resources/audience/segment_members.rb', line 69

def each(list_id, segment_id, query: nil, body: nil, headers: nil, &block)
  list_each_item(:members, list_id, segment_id, query: query, body: body, headers: headers, &block)
end

#list(list_id, segment_id, query: nil, body: nil, headers: nil) ⇒ Response

List members in a specific segment

Examples:

Get members in a segment

segment_members.list('list123', 'segment456')

Parameters:

  • list_id (String) —

    The ID of the Mailchimp list

  • segment_id (String) —

    The ID of the segment

  • query (Hash) (defaults to: nil) —

    Optional query parameters

  • body (Hash) (defaults to: nil) —

    Optional request body

  • headers (Hash) (defaults to: nil) —

    Optional request headers

Returns:

  • (Response) —

    API response containing segment members



22
23
24
25
 
# File 'lib/mailchimp-api/resources/audience/segment_members.rb', line 22

def list(list_id, segment_id, query: nil, body: nil, headers: nil)
  path = "/lists/#{list_id}/segments/#{segment_id}/members"
  client.get(path, query: query, body: body, headers: headers)
end