Describes an EmailCampaign that can be assigned lists and sent either directly through the API or via the VerticalResponse user interface. Though it’s possible to use one of VerticalResponse’s pre-built templates, if you’re using the API to generate emails, we recommend that you create the HTML and text layout for your email campaign on your system and pass those contents in the form of either a freeform or canvas email type.
- id [xsd:int]
- This campaign’s ID. Provided by VerticalResponse. Only required if updating a campaign.
- hash [xsd:string]
- A 10-character hexadecimal string that uniquely identifies this campaign. Provided by VerticalResponse.
- name [xsd:string]
- REQUIRED: The name used to identify this campaign in the list of sent and unsent emails in your VerticalResponse account.
- type [xsd:string]
-
REQUIRED: The type of email you are creating, which must be one of the following:
- template – Editable using the “Wizard” in the VerticalResponse application. If you choose this type, you must also specify a template_id.
- canvas – Editable using the “Canvas” in the VerticalResponse application.
- freeform – Fully-formed HTML/Text. Can be edited in the VerticalResponse application using the non-WYSIWYG editor.
- freeform_text – Fully-formed text-only email. Can be edited in the VerticalResponse application using the non-WYSIWYG editor.
- template_id [xsd:int]
- For template campaigns, this identifies the template used. Templates are referred to as “borders” in the VerticalResponse application. Only required for email campaigns of type “template”.
- status [xsd:string]
- DEPRECATED: The internal status of this campaign. The use of this value is deprecated. Please use display_status instead.
- display_status [xsd:string]
- The status of this campaign. Set by VerticalResponse.
- tested [xsd:boolean]
- Whether this campaign has been test mailed. Set by VerticalResponse.
- declined [xsd:boolean]
- Whether this campaign has been declined for mailing by VerticalResponse. Set by VerticalResponse.
- from_label [xsd:string]
- REQUIRED: The name or email address this campaign should appear to be sent from. This value is usually displayed in the recipient’s email client instead of the actual “from” email address.
- support_email [xsd:string]
- The email address to which replies to this campaign will be sent.
- send_friend [xsd:boolean]
- Whether the “Forward to a Friend” feature has been activated for this campaign.
- redirect_url [xsd:string]
- For template campaigns, this is the click-through link used for the logo at the top.
- sent_size [xsd:int]
- The number of unique recipients of this campaign. Set by VerticalResponse. Available after the campaign has been launched.
- creation_date [xsd:dateTime]
- When this campaign was created. Set by VerticalResponse.
- last_updated [xsd:dateTime]
- The last time this campaign was modified. Set by VerticalResponse.
- mail_date [xsd:dateTime]
- The date when this campaign should mail in the ISO-8601 date format.
- additional_costs [xsd:float]
- Additional costs of this campaign – used for calculating ROI.
- contents [vrtypens:ArrayOfEmailCampaignContent]
- An array of EmailCampaignContent objects that define the actual content of this campaign.
- modules [vrtypens:ArrayOfTemplateCampaignModule]
- For template campaigns, this is a list of the TemplateCampaignModules that have been added.
- lists [vrtypens:ArrayOfList]
- The set of lists that are attached to this campaign (if asked for). Can be set later using the method setCampaignLists().