The campaign object stores all the information regarding a single campaign (newsletter / mailing) in your dotMailer account.
A campaign may have both HTML and Plain Text versions, sent to contacts in address book based on their preferences..
Campaigns can be created using CreateCampaign and sent via various means.
The Custom From Address is set separately using SetCustomFromAddress.
Elements
| fromName |
string |
The name that the email campaign should appear to be from. |
| htmlContent |
string |
The contents of the HTML email; this will be validated before saving and must contain an unsubscribe link (http://$UNSUB$). |
| id |
int |
The system generated ID for the campaign. |
| name |
string |
The name of the campaign as it appears in your account; this is not directly exposed to the
end recipient and may be different to the subject line. (The name is used in Google Analytics
campaign tagging so should be kept recipient friendly.) |
| plaintextContent |
string |
The contents of the Plain Text email; this will be validated before saving and must contain an unsubscribe link (http://$UNSUB$). |
| replyAction |
Unset or WebMailForward or Webmail or Delete |
What should be done with replies received to the campaign. |
| replyToAddress |
string |
If the reply action is set to WebMailForward, what email address they should be forwarded to. |
| status |
NotSet or Unsent or Sending or Sent or Paused or Cancelled or RequiresApproval or
RequiresSMSApproval or Triggered |
The status of the campaign; a campaign exists in draft (Unsent) form until ready for sending;
sending may take several minutes, as such there is a Sending from which it may be paused,
cancelled, or proceed to Sent.
(Note: a campaign may only be paused or cancelled from
within the application, there is not yet a method to do this through the API).)
A Triggered campaign is one that is sent in response to an action, such as someone
joining an address book.
The statuses RequiresApproval and RequiresSMSApproval are anti‑abuse measures;
you will not be able to set a campaign to or from either of these states via the API. |
| subject |
string |
The subject line of the email. |