Module: MailchimpAPI::Audience::MemberTags::APIs

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

Overview

Module with endpoints for MemberTags APIs

Instance Method Summary collapse

Instance Method Details

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

Add or update tags for a member

Examples:

Add tags to a member

member_tags.create('list123', '[email protected]', body: {
  tags: [
    { name: 'Customer', status: 'active' },
    { name: 'VIP', status: 'active' }
  ]
})

Parameters:

  • list_id (String) —

    The ID of the Mailchimp list

  • email (String) —

    The member’s email address

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

    Optional query parameters

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

    Tags to add/update

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

    Optional request headers

Options Hash (body:):

  • :tags (Array<Hash>) —

    Array of tag objects

Returns:

  • (Response) —

    API response containing update status



42
43
44
45
 
# File 'lib/mailchimp-api/resources/audience/member_tags.rb', line 42

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

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

Iterate through all tags for a member

Examples:

Iterate through member tags

member_tags.each('list123', '[email protected]') do |tag|
  puts tag[:name]
end

Parameters:

  • list_id (String) —

    The ID of the Mailchimp list

  • email (String) —

    The member’s email address

  • 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 member tag



58
59
60
 
# File 'lib/mailchimp-api/resources/audience/member_tags.rb', line 58

def each(list_id, email, query: nil, body: nil, headers: nil, &block)
  list_each_item(:tags, list_id, email, query: query, body: body, headers: headers, &block)
end

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

List tags for a specific member

Examples:

Get tags for a member

member_tags.list('list123', '[email protected]')

Parameters:

  • list_id (String) —

    The ID of the Mailchimp list

  • email (String) —

    The member’s email address

  • 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 member tags



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

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