You are here

Home » API reference » Mailchimp 7 » MCAPI.class.php » MCAPI

function MCAPI::campaignCreate in Mailchimp 7

Same name and namespace in other branches
  1. 5.2 MCAPI.class.php \MCAPI::campaignCreate()
  2. 5 MCAPI.class.php \MCAPI::campaignCreate()
  3. 6.2 MCAPI.class.php \MCAPI::campaignCreate()
  4. 6 MCAPI.class.php \MCAPI::campaignCreate()

Create a new draft campaign to send

Related

@example mcapi_campaignCreate.php @example xml-rpc_campaignCreate.php @example xml-rpc_campaignCreateABSplit.php @example xml-rpc_campaignCreateRss.php

Parameters

string $type the Campaign Type to create - one of "regular", "plaintext", "absplit", "rss", "trans", "auto":

array $options a hash of the standard options for this campaign :: string list_id the list to send this campaign to- get lists using lists() string subject the subject line for your campaign message string from_email the From: email address for your campaign message string from_name the From: name for your campaign message (not an email address) string to_email the To: name recipients will see (not email address) integer template_id optional - use this template to generate the HTML content of the campaign integer folder_id optional - automatically file the new campaign in the folder_id passed array tracking optional - set which recipient actions will be tracked, as a struct of boolean values with the following keys: "opens", "html_clicks", and "text_clicks". By default, opens and HTML clicks will be tracked. string title optional - an internal name to use for this campaign. By default, the campaign subject will be used. boolean authenticate optional - set to true to enable SenderID, DomainKeys, and DKIM authentication, defaults to false. array analytics optional - if provided, use a struct with "service type" as a key and the "service tag" as a value. For Google, this should be "google"=>"your_google_analytics_key_here". Note that only "google" is currently supported - a Google Analytics tags will be added to all links in the campaign with this string attached. Others may be added in the future boolean auto_footer optional Whether or not we should auto-generate the footer for your content. Mostly useful for content from URLs or Imports boolean inline_css optional Whether or not css should be automatically inlined when this campaign is sent, defaults to false. boolean generate_text optional Whether of not to auto-generate your Text content from the HTML content. Note that this will be ignored if the Text part of the content passed is not empty, defaults to false.

array $content the content for this campaign - use a struct with the following keys:: "html" for pasted HTML content "text" for the plain-text version "url" to have us pull in content from a URL. Note, this will override any other content options - for lists with Email Format options, you'll need to turn on generate_text as well "archive" to send a Base64 encoded archive file for us to import all media from. Note, this will override any other content options - for lists with Email Format options, you'll need to turn on generate_text as well "archive_type" optional - only necessary for the "archive" option. Supported formats are: zip, tar.gz, tar.bz2, tar, tgz, tbz . If not included, we will default to zip

If you chose a template instead of pasting in your HTML content, then use "html_" followed by the template sections as keys - for example, use a key of "html_MAIN" to fill in the "MAIN" section of a template. Supported template sections include: "html_HEADER", "html_MAIN", "html_SIDECOLUMN", and "html_FOOTER"

array $segment_opts optional - if you wish to do Segmentation with this campaign this array should contain: see campaignSegmentTest(). It's suggested that you test your options against campaignSegmentTest(). Also, "trans" campaigns <strong>do not</strong> support segmentation.:

array $type_opts optional -: For RSS Campaigns this, array should contain: string url the URL to pull RSS content from - it will be verified and must exist string schedule optional one of "daily", "weekly", "monthly" - defaults to "daily" string schedule_hour optional an hour between 0 and 24 - default to 4 (4am <em>local time</em>) - applies to all schedule types string schedule_weekday optional for "weekly" only, a number specifying the day of the week to send: 0 (Sunday) - 6 (Saturday) - defaults to 1 (Monday) string schedule_monthday optional for "monthly" only, a number specifying the day of the month to send (1 - 28) or "last" for the last day of a given month. Defaults to the 1st day of the month

For A/B Split campaigns, this array should contain: string split_test The values to segment based on. Currently, one of: "subject", "from_name", "schedule". NOTE, for "schedule", you will need to call campaignSchedule() separately! string pick_winner How the winner will be picked, one of: "opens" (by the open_rate), "clicks" (by the click rate), "manual" (you pick manually) integer wait_units optional the default time unit to wait before auto-selecting a winner - use "3600" for hours, "86400" for days. Defaults to 86400. integer wait_time optional the number of units to wait before auto-selecting a winner - defaults to 1, so if not set, a winner will be selected after 1 Day. integer split_size optional this is a percentage of what size the Campaign's List plus any segmentation options results in. "schedule" type forces 50%, all others default to 10% string from_name_a optional sort of, required when split_test is "from_name" string from_name_b optional sort of, required when split_test is "from_name" string from_email_a optional sort of, required when split_test is "from_name" string from_email_b optional sort of, required when split_test is "from_name" string subject_a optional sort of, required when split_test is "subject" string subject_b optional sort of, required when split_test is "subject"

For AutoResponder campaigns, this array should contain: string offset-units one of "day", "week", "month", "year" - required string offset-time the number of units, must be a number greater than 0 - required string offset-dir either "before" or "after" string event optional "signup" (default) to base this on double-optin signup, "date" or "annual" to base this on merge field in the list string event-datemerge optional sort of, this is required if the event is "date" or "annual"

Return value

string the ID for the created campaign

File

./MCAPI.class.php, line 320

Class

MCAPI

Code

function campaignCreate($type, $options, $content, $segment_opts = NULL, $type_opts = NULL) {
  $params = array();
  $params["type"] = $type;
  $params["options"] = $options;
  $params["content"] = $content;
  $params["segment_opts"] = $segment_opts;
  $params["type_opts"] = $type_opts;
  return $this
    ->callServer("campaignCreate", $params);
}