Sign in
Messages

Update message attributes

Updates the attributes (folders, stars, read/unread status, and so on) for the specified email message.

When you make a PUT request, Nylas replaces all data in the nested object with the information included in your request. For more information, see Updating objects.

put/v3/grants/{grant_id}/messages/{message_id}

Query parameters

selectstring

Specify fields that you want Nylas to return, as a comma-separated list (for example, select=id,updated_at). This allows you to receive only the portion of object data that you're interested in. You can use select to optimize response size and reduce latency by limiting queries to only the information that you need.

query_imapboolean

(IMAP, iCloud, and Yahoo only) When true, Nylas queries from the IMAP server directly instead of the Nylas database.

shared_fromstring

(Microsoft only) When provided, Nylas returns items that were shared from the specified email address. It also accepts grant ID. This parameter only accepts single email address or grant ID. Check out the Shared folders guide for more information.

Request body

starredboolean

Set to true to mark as starred; false to mark as not starred.

unreadboolean

Set to true to mark as unread; false to mark as read.

foldersstring[]

The ID(s) of the folder(s) to apply, overwriting all folders previously associated with the message. Microsoft messages can be in a single folder only. Google allows a single message to appear in multiple folders.

metadataMetadata

The metadata associated with the object. For more information, see Metadata.

Example request

{
  "starred": true,
  "unread": true,
  "folders": [
    "folder-1",
    "folder-2"
  ]
}

Response

Message response

request_idstring

The request ID.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.