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
RESTGEThttps://[Your URL]/api/2.0/emails/:id
XML-RPCCallemails.UpdateEmail

Parameters

PropertyTypeDescriptionDefaultRequiredRead Only
$idintegerThe ID of the email to update.noneyesn/a
approval_emailstringEmailemptynono
approval_namestringNameemptynono
approval_required stringApproval required Possible values:
yes
no
nonono
attachments stringAttachmentsemptynono
campaign_namestringCampaignemptynono
haracter_setstringCharacter setutf-8nono
embeded_imagesstringEmbed images Possible values:
yes
no
nonono
encodingstringEncoding Possible values:
7bit
8bit
binary
quoted-printable
base64
8bitnono
filter_idstringFilter identifieremptynono
from_emailstringFrom emailemptynono
from_namestringFrom nameemptynono
html_fetch_urlstringFetch HTML URLemptynono
html_fetch_whenstringFetch HTML when Possible values:
now
confirm
send
nownono
html_originalstringOriginal HTMLemptynono
include_analyticsstringGoogle analytics Possible values:
yes
no
nonono
inline_cssstringConvert CSS to inline styles Possible values:
yes
no
yesnono
insert_unsubscribe_linkstringstringInsert unsubscribe footer Possible values:
yes
no
nonono
is_copy_text_autostringCopy text from HTML Possible values:
yes
no
yesnono
is_html_fetch_from_urlstringFetch HTML from URL Possible values:
yes
no
nonono
is_scheduledstringScheduled Possible Values:
yes
no
nonono
is_text_fetch_from_url stringFetch text from URL Possible values:
yes
no
nonono
list_idsstringList identifiersemptynono
prioritystringPriority Possible values:
low
medium
high
mediumnono
reply_emailstringReply emailemptynono
scheduled_previous_message_idintegerPrevious scheduled message identifier0nono
scheduled_recurrence stringSchedule recurrence Possible values:
once
weekdays
daily
weekly
monthly
yearly
oncenono
send_scheduled_dateintegerSchedule date0nono

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": "administrator@pmailer.co.za",
        "from_name": "Administrator From",
        "reply_email": "administrator@pmailer.co.za",
        "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"
    }
}