Module: MailchimpAPI::Audiences::APIs

Includes:
Pagination::ListEachItemHelper
Included in:
MailchimpAPI::Audiences, MailchimpAPI::Audiences
Defined in:
lib/mailchimp-api/resources/audiences.rb

Overview

Module with endpoints for Audiences APIs

Instance Method Summary collapse

Instance Method Details

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

Batch update members in audience

Examples:

Update existing members

audiences.update('audience789', body: {
  members: members,
  update_existing: true
})

Parameters:

  • list_id (String) —

    The ID of the audience

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

    Optional query parameters

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

    Updated audience attributes

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

    Optional request headers

Returns:

  • (Response) —

    API response containing updated audience



87
88
89
90
 
# File 'lib/mailchimp-api/resources/audiences.rb', line 87

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

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

Create a new audience

Examples:

Create a new folder

audiences.create(body: {name: 'Product Updates'})

Parameters:

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

    Optional query parameters

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

    Audience attributes

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

    Optional request headers

Returns:

  • (Response) —

    API response containing the created folder



30
31
32
33
 
# File 'lib/mailchimp-api/resources/audiences.rb', line 30

def create(query: nil, body: nil, headers: nil)
  path = "/lists"
  client.post(path, query: query, body: body, headers: headers)
end

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

Delete an audience

Examples:

Delete an audience

audiences.delete('audience789')

Parameters:

  • list_id (String) —

    The ID of the audience

  • 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:



56
57
58
59
 
# File 'lib/mailchimp-api/resources/audiences.rb', line 56

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

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

Iterate through all audiences

Examples:

Iterate through all audiences

audiences.each do |audience|
  puts audience[:name]
end

Parameters:

  • list_id (String) —

    The ID of the audience

  • 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 audience



102
103
104
 
# File 'lib/mailchimp-api/resources/audiences.rb', line 102

def each(query: nil, body: nil, headers: nil, &block)
  list_each_item(:lists, query: query, body: body, headers: headers, &block)
end

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

List audiences

Examples:

Get audiences

audiences.list

Parameters:

  • 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 audiences



18
19
20
21
 
# File 'lib/mailchimp-api/resources/audiences.rb', line 18

def list(query: nil, body: nil, headers: nil)
  path = "/lists"
  client.get(path, query: query, body: body, headers: headers)
end

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

Show details for a specific audience

Examples:

Get details for an audience

audiences.show('audience789')

Parameters:

  • list_id (String) —

    The ID of the audience

  • 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 audience details



43
44
45
46
 
# File 'lib/mailchimp-api/resources/audiences.rb', line 43

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

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

Update an audience

Examples:

Update an audience name

audiences.update('audience789', body: {
  name: 'Updated Audience Name'
})

Parameters:

  • list_id (String) —

    The ID of the audience

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

    Optional query parameters

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

    Updated audience attributes

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

    Optional request headers

Returns:

  • (Response) —

    API response containing updated audience



71
72
73
74
 
# File 'lib/mailchimp-api/resources/audiences.rb', line 71

def update(list_id, query: nil, body: nil, headers: nil)
  path = "/lists/#{list_id}"
  client.patch(path, query: query, body: body, headers: headers)
end