Call us toll free @ 888-497-7898

email - editcampaign

Allows editing of a campaign

Notes: You can not edit a pausing/sending/ or completed campaign.


API Call Information
area: email
action: editcampaign

API Arguments
Argument Data Type Required Description
id integer Yes campaign id
clicktracking boolean either 1 or 0 No either 1 or 0 to have click tracking or not. Default is 1
title string No title of the campaign
subject string No subject line
listid integer No list id
profileid integer No profile id to send the campaign from
whoisid integer No can spam/whois footer id
messageid integer No message id for the message
date integer No unixtime stamp of date or leave out to send right now. Time is based on CST timezone.
fromaddress string No the prefix of the email address such as info jobs sales
fromname string No From Name
suppressionid integer No list id of the suppression that you want to use. Seperate multiple suppression lists by a comma
viewaswebpage boolean either 1 or 0 No values either 0 or 1 for having it or not
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
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
opentracking boolean either 1 or 0 No either 1 or 0 to have open tracking or not. Default is 1
emailsperhour integer No Valid values are 15,30,60 and then anything from 80 to 90000 which represent how many emails per hour
priority string No priority level for campaign takes values of low,lowest,normal,high,highest
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!
API Url Example:
https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=email&action=editcampaign&id=123456&listid=12345&subject=hello&fromaddress=sales&fromname=John&profileid=12345&messageid=12345&whoisid=12345

API Result:
XML Response JSON Response
<response>
  <success>Campaign Updated</success>
  <id>1111</id>
</response>
{
    "success": "Campaign Updated",
    "id": "1111"
}