Log in Talk to an expert

createcampaign

area emailaction createcampaignPOSTdestructive

Sends an email campaign

Arguments

ArgumentTypeRequiredDescription
titlestringYestitle of the campaign used for your own reference
subjectstringYesyour subject line
listidintegerYeslist id of the list that you want to use
profileidintegerYesprofile id to send the campaign from
whoisidintegerYescan spam/whois footer id
messageidintegerYesmessage id for the message
fromaddressstringYesthe prefix of the email address such as info jobs sales Do not include the @ sign
fromnamestringYesFrom Name
dateintegerNounixtime stamp of date or leave out to send right now. Time is based on CST timezone.
suppressionidstringNolist id of the suppression that you want to use. optional Separate multiple suppression id's with a comma
sendtypeboolean (1 or 0)Novalues either 0 for full campaign or 1 for partial campaign using start and ending indexes.
startindexintegerNoUsed in partial campaigns integer value of the start email id position in the list
endindexintegerNoUsed in partial campaigns integer value of the end email id position in the list
viewaswebpageboolean (1 or 0)Novalues either 0 or 1 for having it or not
customfromintegerNocustom from address integer. Found under stored custom from names
textpartboolean (1 or 0)Novalues either 0 or 1 for having it or not
onlytextpartboolean (1 or 0)Novalues either 0 or 1 for having it or not
trackingprofileintegerNoprofile id integer only use if you want a different tracking domain then your sending domain
copyopenintegerNolist id to copy openers to
copyclickerintegerNolist id to copy clickers to
opentrackingboolean (1 or 0)Noeither 1 or 0 to have open tracking or not. Default is 1
prioritystringNopriority level for campaign takes values of low,lowest,normal,high,highest
clicktrackingboolean (1 or 0)Noeither 1 or 0 to have click tracking or not. Default is 1
sendbehaviorstringNoOptional takes either one of the following options: sendnotoc,sendnotdelivered,sendoc,sendonlyopeners Details: sendnotoc - Do not send to openers or clickers sendnotdelivered - Send not to delivered. sendoc - Send only to openers clickers sendonlyopeners - Send only to openers
smtpserverstringNoOptional smtp server id. If you want to send off an added SMTP Server email account. You can include multiple by separating by a comma such as 1,2,3,4
replyto_emailstringNoSets the reply email address not required. Warning your email address will be exposed in every email sent out
rotateprofilesstringNoA list of profile ids separated by a comma, Pleas ensure you are only rotating profiles that are part of the same server id!
emailsperhourintegerNoValid values are 15,30,60 and then anything from 80 to 90000 which represent how many emails per hour

Example request

https://api.mailclickconvert.com/api.php
  ?apikey=YOUR_API_KEY
  &area=email
  &action=createcampaign
  &listid=12345
  &subject=hello
  &fromaddress=sales
  &fromname=John
  &profileid=12345
  &messageid=12345
  &whoisid=12345

The platform expects this call as a POST; the parameters are the same either way.

Response

<response>
  <success>Campaign Added to Queue</success>
  <id>3453</id>
</response>
Related

More in Campaigns.

blreport

POSTwrite

Gets list of blocked responses from a campaign that appear to be from blacklists

campaignlog

GETread

Gets the details of a campaign from the campaign log. For each chunk update. This data builds the campaign graph.

deletecampaign

POSTdestructive

Deletes a campaign given a campaign id

deletereoccurringcampaign

POSTdestructive

Deletes a recurring campaign given the recurring id

deletetrigger

POSTdestructive

Deletes a trigger given a trigger id

editcampaign

POSTwrite

Allows editing of a campaign

Need a call that isn't here?

Custom integration work is quoted on scope, and support is a person on weekdays, 9am to 5pm CST.

Talk to usBack to the API list