Module: MailchimpAPI::Campaign::Content::APIs

Included in:
MailchimpAPI::Campaign::Content, MailchimpAPI::Campaign::Content
Defined in:
lib/mailchimp-api/resources/campaign/content.rb

Overview

Module with endpoints for Campaign::Content APIs

Instance Method Summary collapse

Instance Method Details

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

Get campaign content

Examples:

Get the the HTML and plain-text content for a campaign.

campaign_content.show('campaign789')

Parameters:

  • campaign_id (String) —

    The ID of the campaign

  • 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 campaign content details



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

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

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

Set campaign content

Examples:

Set a campaign plain-text and HTML content

campaigns.update('campaign789', body: {
  plain_text: 'Plain Text', html: { "<p>Raw HTML</p>" }
})

Parameters:

  • campaign_id (String) —

    The ID of the campaign

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

    Optional query parameters

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

    New campaign content data

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

    Optional request headers

Returns:

  • (Response) —

    API response containing updated campaign content details



33
34
35
36
 
# File 'lib/mailchimp-api/resources/campaign/content.rb', line 33

def update(campaign_id, query: nil, body: nil, headers: nil)
  path = "/campaigns/#{campaign_id}/content"
  client.put(path, query: query, body: body, headers: headers)
end