Daylite WebsiteMarketcircle Blog
API Reference

Email

patch
https://api.marketcircle.net/v1/emails/

Modify an email

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

See Email for the attributes. Attributes you leave out are not changed.

subject, from, to, cc and bcc can only be changed when the Daylite setting that allows editing email content is on; otherwise each returns read_only. Categories, keywords, links and the owner can always be changed:

{ "keywords": { "add": ["Follow up"] }, "contacts": { "add": [{ "contact": "/v1/contacts/1000" }] } }

An email in the trash can't be edited (404 with {"error":"trashed_object"}) until you restore it with {"trashed": false}. A successful update returns 204 No Content.

Path Params
int32
required

The email ID

Body Params
string

Subject (max 512 characters). Only editable when the Daylite setting that allows editing email content is on; otherwise the update returns read_only for this attribute.

string

Sender, e.g. Jane Smith <[email protected]>. Only editable when the Daylite setting that allows editing email content is on; otherwise the update returns read_only for this attribute.

string

Recipients as one comma-separated string, e.g. [email protected], Bob <[email protected]>. Only editable when the Daylite setting that allows editing email content is on; otherwise the update returns read_only for this attribute.

string

CC recipients as one comma-separated string. Only editable when the Daylite setting that allows editing email content is on; otherwise the update returns read_only for this attribute.

string

BCC recipients as one comma-separated string. Only editable when the Daylite setting that allows editing email content is on; otherwise the update returns read_only for this attribute.

string

The email's Message-ID header, e.g. <[email protected]>. Must be unique for each email: the Daylite app and Daylite Mail Assistant rely on it to identify emails, and replies refer to it through parent_message_id. The API does not check this, so make sure you don't reuse a value.

string

The Message-ID of the email this one replies to.

string

Category name. Created if it does not exist. Send null or "" to clear.

keywords

List of keyword names (max 64). Keywords that do not exist are created. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

appointments

Appointments linked to the email. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

contacts

Contacts linked to the email. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

companies

Companies linked to the email. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

opportunities

Opportunities linked to the email. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

projects

Projects linked to the email. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

tasks

Tasks linked to the email. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

groups

Groups linked to the email. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

notes

Notes linked to the email. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

forms

Forms linked to the email. Send an array to replace the list, or {"add": [...], "remove": [...]} to change only some entries.

string

Reference to the user responsible for the email, e.g. /v1/users/1000. Defaults to the user making the request.

boolean

Set to false to restore the email from the trash. Use DELETE to move it to the trash.

Responses
204

204 No Content

Updated 7 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago