Describes an Email that can be assigned lists and sent either directly through the API or via the VerticalResponse user interface. This object is created using the createEmail function; objects of the type Email will be read by older methods (that were written for EmailCampaign objects) as an EmailCampaign object.
- id [xsd:int]
- This email’s ID. Provided by VerticalResponse.
- email_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.
- description [xsd:string]
- A description of the email.
- email_type [xsd:string]
-
REQUIRED: The type of email you are creating, which must be one of the following:
- 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.
- status [xsd:string]
- The status of this campaign.
- hosted_email [xsd:boolean]
- REQUIRED: Whether a hosted version of this email should be provided.
- from_label [xsd:string]
- REQUIRED: The name or email address this email should appear to be sent from. This value is usually displayed in the recipient’s email client instead of the actual “from” email address.
- reply_to_email [xsd:string]
- REQUIRED:The email address to which replies to this email will be sent.
- company_name [xsd:string]
- If set, this overrides the company name shown in the footer of the email.
- send_friend [xsd:boolean]
- Whether the “Forward to a Friend” feature has been activated for this campaign.
- 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. all dates passed through the API should appear in the ISO-8601 date format. Dates passed without a timezone offset are assumed to be GTC, thus emails may not fire when you expect them to. As an example, the following date is acceptable for an email being sent on February 17th, 2012 at 3:45PM PST: 2012-02-17 15:45:00-8:00
- additional_costs [xsd:float]
- Additional costs of this campaign – used for calculating ROI.
- subject [xsd:string]
- REQUIRED: The subject of the email.
- freeform_html [xsd:string]
- REQUIRED: The HTML content of the email.
- freeform_text [xsd:string]
- REQUIRED: The text-only content of the email.
- unsub_message [xsd:string]
- The unsubscribe message at the bottom of the email.
- unsub_link_text [xsd:string]
- The unsubscribe text of the email.
- postal_addr_1 [xsd:string]
- The first line of the street address that will be used in the footer for CAN-SPAM compliance. By default, this will use the address supplied in the Company record.
- postal_addr_2 [xsd:string]
- The second line of the street address that will be used in the footer for CAN-SPAM compliance. By default, this will use the address supplied in the Company record.
- postal_city [xsd:string]
- The city that will be used in the footer for CAN-SPAM compliance. By default, this will use the address supplied in the Company record.
- postal_state [xsd:string]
- The state that will be used in the footer for CAN-SPAM compliance. By default, this will use the address supplied in the Company record.
- postal_code [xsd:string]
- The postal/zip code that will be used in the footer for CAN-SPAM compliance. By default, this will use the address supplied in the Company record.
- postal_country [xsd:string]
- The country that will be used in the footer for CAN-SPAM compliance. By default, this will use the address supplied in the Company record.
- tested [xsd:boolean]
- Whether the new email should be considered to have been test emailed. Defaults to false. Note: If the user will not use the VerticalResponse web site to send this email, you should set this value to “true”
- previewed_html [xsd:boolean]
- Whether the new email should be considered to have had its HTML version previewed. Defaults to false. Note: If the user will not use the VerticalResponse web site to send this email, you should set this value to “true”
- previewed_text [xsd:boolean]
- Whether the new email should be considered to have had its text-only version previewed. Defaults to false. Note: If the user will not use the VerticalResponse web site to send this email, you should set this value to “true”