Overview
You can use this request to update the properties of an email. Use the Email’s ID to specify which email to update, and submit an array of the properties that need to be changed.
The Method
| API | - | Method |
|---|---|---|
| REST | GET | https://[Your URL]/api/2.0/emails/:id |
| XML-RPC | Call | emails.UpdateEmail |
Parameters
| Property | Type | Description | Default | Required | Read Only |
|---|---|---|---|---|---|
| $id | integer | The ID of the email to update. | none | yes | n/a |
| approval_email | string | empty | no | no | |
| approval_name | string | Name | empty | no | no |
| approval_required | string | Approval required Possible values: yes no | no | no | no |
| attachments | string | Attachments | empty | no | no |
| campaign_name | string | Campaign | empty | no | no |
| haracter_set | string | Character set | utf-8 | no | no |
| embeded_images | string | Embed images Possible values: yes no | no | no | no |
| encoding | string | Encoding Possible values: 7bit 8bit binary quoted-printable base64 | 8bit | no | no |
| filter_id | string | Filter identifier | empty | no | no |
| from_email | string | From email | empty | no | no |
| from_name | string | From name | empty | no | no |
| html_fetch_url | string | Fetch HTML URL | empty | no | no |
| html_fetch_when | string | Fetch HTML when Possible values: now confirm send | now | no | no |
| html_original | string | Original HTML | empty | no | no |
| include_analytics | string | Google analytics Possible values: yes no | no | no | no |
| inline_css | string | Convert CSS to inline styles Possible values: yes no | yes | no | no |
| insert_unsubscribe_linkstring | string | Insert unsubscribe footer Possible values: yes no | no | no | no |
| is_copy_text_auto | string | Copy text from HTML Possible values: yes no | yes | no | no |
| is_html_fetch_from_url | string | Fetch HTML from URL Possible values: yes no | no | no | no |
| is_scheduled | string | Scheduled Possible Values: yes no | no | no | no |
| is_text_fetch_from_url | string | Fetch text from URL Possible values: yes no | no | no | no |
| list_ids | string | List identifiers | empty | no | no |
| priority | string | Priority Possible values: low medium high | medium | no | no |
| reply_email | string | Reply email | empty | no | no |
| scheduled_previous_message_id | integer | Previous scheduled message identifier | 0 | no | no |
| scheduled_recurrence | string | Schedule recurrence Possible values: once weekdays daily weekly monthly yearly | once | no | no |
| send_scheduled_date | integer | Schedule date | 0 | no | no |
Example Request
PUT /api/2.0/emails/1
HTTP/1.1
Host: local.everlytic.com
Authorization: Basic YWRtaW5pc3RyYXRvcjp2bE1lTGk2UlVJR21SQzNvaWRMZXBsc2J5RU5NRkY3Yl85OTk=
Content-Type: application/json
{
"subject":"my first email"
}
Example Response
{
"links": [
{
"title": "Self",
"rel": "self",
"href": "https://local.everlytic.com/api/2.0/emails/1"
},
{
"title": "Home",
"rel": "home",
"href": "https://local.everlytic.com/api/2.0/"
},
{
"title": "ListEmails",
"rel": "collection",
"href": "https://local.everlytic.com/api/2.0/emails"
}
],
"item": {
"id": 1,
"hash": "abc",
"campaign_id": 0,
"recreated_from_message_id": 0,
"type": "email",
"compose_with": "",
"campaign_name": "",
"subject": "my first email",
"from_email": "[email protected]",
"from_name": "Administrator From",
"reply_email": "[email protected]",
"preheader_text": null,
"html_original": "",
"is_html_fetch_from_url": "no",
"html_fetch_url": "",
"html_fetch_when": "now",
"is_text_fetch_from_url": "no",
"text_fetch_url": "",
"text_fetch_when": "now",
"is_copy_text_auto": "no",
"remove_duplicates": "no",
"attachments": "",
"has_dynamic_attachments": "no",
"thumbnail": "",
"list_ids": "1,",
"filter_id": 0,
"import_id": 0,
"message_workflow_id": 0,
"template_id": 0,
"create_date": 0,
"is_scheduled": "no",
"send_scheduled_date": 1249382460,
"scheduled_recurrence": "once",
"scheduled_previous_message_id": 0,
"preparation_date": 0,
"preparation_count": 0,
"send_date": 1230768000,
"approval_required": "no",
"approval_request_date": 0,
"approval_name": "",
"approval_email": "",
"approved_date": 0,
"inline_css": "no",
"embed_images": "no",
"track_links": "yes",
"track_reads": "yes",
"track_attachments": "no",
"unsubscribe_type": "none",
"insert_unsubscribe_link": "no",
"include_analytics": "no",
"include_custom_analytics": "no",
"analytics_custom_tag": "",
"analytics_tag": "",
"analytics_medium_tag": "email",
"total_sent": 500,
"total_actual_sent": 500,
"total_failed": 0,
"total_actual_failed": 0,
"total_to_be_queued": 0,
"total_queued": 500,
"total_in_queue": 0,
"total_link_clicks": 50,
"total_link_clicks_unique": 30,
"total_link_clicks_anonymous": 0,
"total_reads": 75,
"total_reads_inferred": 60,
"total_reads_unique": 45,
"total_reads_anonymous": 0,
"message_total_reads_unique_desktop": 0,
"message_total_reads_desktop": 0,
"message_total_reads_unique_web": 0,
"message_total_reads_web": 0,
"message_total_reads_unique_mobile": 0,
"message_total_reads_mobile": 0,
"message_total_reads_unique_unknown": 0,
"message_total_reads_unknown": 0,
"total_unsubscribes": 3,
"total_bounces": 0,
"total_bounces_hard": 0,
"total_bounces_soft": 0,
"total_bounces_policy": 0,
"total_bounces_blacklist": 0,
"total_complaints": 0,
"total_complaints_real": 0,
"total_complaints_fbl": 0,
"total_forwards": 0,
"total_autoresponders": 0,
"total_unique_ attachments": 0,
"total_attachments": 0,
"total_bounces_unidentified": 0,
"send_share_report": "no",
"share_report_recipients": "",
"share_report_delay_days": 0,
"share_report_allow_export": "no",
"status": "composing",
"priority": "medium",
"character_set": "utf-8",
"encoding": "8bit"
}
}