title |
string |
Yes |
title of the campaign used for your own reference |
subject |
string |
Yes |
your subject line |
listid |
integer |
Yes |
list id of the list that you want to use |
profileid |
integer |
Yes |
profile id to send the campaign from |
whoisid |
integer |
Yes |
can spam/whois footer id |
messageid |
integer |
Yes |
message id for the message |
fromaddress |
string |
Yes |
the prefix of the email address such as info jobs sales
Do not include the @ sign |
fromname |
string |
Yes |
From Name |
date |
integer |
No |
unixtime stamp of date or leave out to send right now. Time is based on CST timezone. |
suppressionid |
string |
No |
list id of the suppression that you want to use. optional Separate multiple suppression id's with a comma |
sendtype |
boolean either 1 or 0 |
No |
values either 0 for full campaign or 1 for partial campaign using start and ending indexes. |
startindex |
integer |
No |
Used in partial campaigns integer value of the start email id position in the list |
endindex |
integer |
No |
Used in partial campaigns integer value of the end email id position in the list |
viewaswebpage |
boolean either 1 or 0 |
No |
values either 0 or 1 for having it or not |
customfrom |
integer |
No |
custom from address integer. Found under stored custom from names |
textpart |
boolean either 1 or 0 |
No |
values either 0 or 1 for having it or not |
onlytextpart |
boolean either 1 or 0 |
No |
values either 0 or 1 for having it or not |
trackingprofile |
integer |
No |
profile id integer only use if you want a different tracking domain then your sending domain |
copyopen |
integer |
No |
list id to copy openers to |
copyclicker |
integer |
No |
list id to copy clickers to |
opentracking |
boolean either 1 or 0 |
No |
either 1 or 0 to have open tracking or not. Default is 1 |
priority |
string |
No |
priority level for campaign takes values of low,lowest,normal,high,highest |
clicktracking |
boolean either 1 or 0 |
No |
either 1 or 0 to have click tracking or not. Default is 1 |
sendbehavior |
string |
No |
Optional 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 |
smtpserver |
string |
No |
Optional 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_email |
string |
No |
Sets the reply email address not required. Warning your email address will be exposed in every email sent out |
rotateprofiles |
string |
No |
A list of profile ids separated by a comma, Pleas ensure you are only rotating profiles that are part of the same server id! |
emailsperhour |
integer |
No |
Valid values are
15,30,60 and then anything from 80 to 90000 which represent how many emails per hour |
