The Launch command allows you to send a campaign to a list or segment of contacts. The command requires the following arguments: Command, List, and Format.
cmd=launch&list_id=5&format=99
The command is ‘launch’, the list properties are defined in list with ID ‘5’, the template defined in the list properties will be sent as a MIME formatted message to all contacts.
Example
Using many commands and arguments (please note the command is wrapped for display purposes only):
cmd=launch&realm=myrealm_child&list_id=5&segmentation_id=10&template_id=42&campaign_name=FTPAPI&subject=New%20Subject&format=99&seed_list_id=9¬ify_email=myemail@mydomain.com
A campaign will be created and sent to all contacts that match Segment ‘10’ for List ‘5’ in Realm ‘myrealm_child’, a child of the Realm defined in the header. The MIME content from Template ‘42’ will be used, but the subject will be replaced with “New Subject Text”. RSS contacts will be ignored. In the Campaign Details, the Alias will be ‘FTPAPI’, and an email notification will be sent to ‘myemail@mydomain.com’.
Errors
A Launch command will fail if any of the arguments are invalid, such as the list or template do not exist.
Arguments
The Launch command support the following arguments:
|
Name |
Req? |
Description |
Argument |
|
Command |
Yes |
Defines the command to use. |
cmd=launch |
|
Realm |
|
Name of the realm to run the command. This is optional and only necessary when submitting files to a parent realm in order to manipulate a child realm. |
realm=[realm_name] |
|
List |
Yes |
Identifier of the list properties to use. If you are using one file to perform the same command for several lists, group the command lines in your file by Command and List. This will improve processing efficiency. Alternately, define the list in the header instead of per command. This must refer to a valid list with From and Reply-to. The Launch command only supports one list per command line. |
list_id=[list_id] |
|
Segment |
To send the message to a specific group of contacts, define the segmentation rule ID. This overrides the default of sending to all contacts. To obtain the ID, use the HTTP API, WebServices API, or the web platform directly. |
segmentation_id=[segmentation_id] |
|
|
Template |
Yes |
Identifier of the template content to send. In the template, both Plain Text and HTML must be defined in order to send MIME. The template must be defined in the command if no default is defined in the List properties. |
template_id=[template_id] |
|
Subject |
|
Subject line of the message to send. This overrides the default Subject defined in the Template. Character limit is 48. |
subject=[text] |
|
Format |
Yes |
To specify the format of the email message, set Format to the corresponding value: 1= send Plain Text only 2 = send HTML only 99 = send Multipart MIME |
format=[1,2,99] |
|
Campaign Name |
Use the Campaign Name to apply an alternate name to your Campaign for easy identification. This name is available in some reporting, but not in the UI. |
campaign_name=[campaign_name] |
|
|
RSS |
By default, the campaign will include all RSS contacts. To ignore RSS subscriptions, set the flag to false. |
target_rss=[0,1] DEFAULT==1 |
|
|
Seed List |
To seed a campaign with test addresses from a Seed List, set the seed list ID. |
seed_list_id=[seed_list_id] |
|
|
Suppression List |
|
To suppress contacts in the list from receiving the message, use the Suppression List by defining the Name of the Suppression List. |
suppression_list=[suppression list name] |
|
Notify |
To send a notification when the campaign is complete, set the email address to Notify. |
notify_email=[email]
|
|
|
Account Profile |
To use an Account Profile other than that assigned to the list, define the Account Profile ID. Account Profile support added in v12.03.0. |
acct_pro_id=[account_profile_id] | |
|
Email Snapshot |
Email Snapshot will create and store the HTML and image screenshot of each message sent, including contact-specific personalization. If your Realm is enabled for Email Snapshot, to store a copy of each message, set the 'snapshot' argument to 1. Email Snapshot support added in v15.00.00. |
snapshot=[0,1] | |
|
Google Analytics |
To include Analytics tags in your tracking URLs, the 'ga' argument must be set to 1. If no UTM arguments are included in the command, then the default UTM settings from the Realm will be used. To customize the UTM setting for the specific command, add the &utm_ tag followed by a string value. To ignore the default value from the Realm, use the &utm Remove argument set to 1. For example, to use the default source, medium and campaign, but use a custom content, and blank term, use the following set of arguments: &campaign_name=GoogleEnabled&ga=1&utm_content=Custom%20Content&utm_term_remove=1 Google Analytics support added in v12.13.0. |
ga=[0,1] utm_source=[string] utm_medium=[string] utm_campaign=[string] utm_content=[string] utm_term=[string] utm_source_remove=[0,1] utm_medium_remove=[0,1] utm_campaign_remove=[0,1] utm_content_remove=[0,1] utm_term_remove=[0,1] |