Module: MailchimpAPI::Audience::MergeFields::APIs

Includes:
Pagination::ListEachItemHelper
Included in:
MailchimpAPI::Audience::MergeFields, MailchimpAPI::Audience::MergeFields
Defined in:
lib/mailchimp-api/resources/audience/merge_fields.rb

Overview

Module with endpoints for MergeFields APIs

Instance Method Summary collapse

Instance Method Details

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

Create a new merge field

Examples:

Create a static merge field

merge_fields.create('list123', body: {
  name: 'Settings link',
  tag: 'SETTINGS'
  type: 'text',
  public: false
})

Parameters:

  • list_id (String) —

    The ID of the Mailchimp list

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

    Optional query parameters

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

    Merge field attributes

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

    Optional request headers

Returns:

  • (Response) —

    API response containing the created merge field



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

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

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

Delete a merge field

Examples:

Delete a merge field

merge_fields.delete('list123', 'mergefield456')

Parameters:

  • list_id (String) —

    The ID of the Mailchimp list

  • merge_id (String) —

    The ID of the merge field to delete

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



82
83
84
85
 
# File 'lib/mailchimp-api/resources/audience/merge_fields.rb', line 82

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

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

Iterate through all merge fields for a list

Examples:

Iterate through merge fields

merge_fields.each('list123') do |merge_field|
  puts merge_field[:name]
end

Parameters:

  • list_id (String) —

    The ID of the Mailchimp list

  • 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 merge field



97
98
99
 
# File 'lib/mailchimp-api/resources/audience/merge_fields.rb', line 97

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

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

List merge fields for a specific list

Examples:

Get merge fields for a list

merge_fields.list('list123')

Parameters:

  • list_id (String) —

    The ID of the Mailchimp list

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



20
21
22
23
 
# File 'lib/mailchimp-api/resources/audience/merge_fields.rb', line 20

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

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

Show details for a specific merge field

Examples:

Get details for a merge field

merge_fields.show('list123', 'mergefield456')

Parameters:

  • list_id (String) —

    The ID of the Mailchimp list

  • merge_id (String) —

    The ID of the merge field

  • 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 merge field details



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

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

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

Update a merge field

Examples:

Update a merge field name

merge_fields.update('list123', 'mergefield456', body: {
  name: 'Updated Merge Field Name'
})

Parameters:

  • list_id (String) —

    The ID of the Mailchimp list

  • merge_id (String) —

    The ID of the merge field to update

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

    Optional query parameters

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

    Updated merge field attributes

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

    Optional request headers

Returns:

  • (Response) —

    API response containing updated merge field



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

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