Sign in
Threads

Update a thread

Updates the specified thread.

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}/threads/{thread_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.

shared_folder_idstring

(Microsoft only) When provided, Nylas returns items from the specified shared folder ID. Required when using shared_from. This parameter only accepts a single folder ID. Check out the Shared folders guide for more information.

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

When true, indicates that the thread is starred.

unreadboolean

When false, indicates that all messages in the thread have been read.

foldersstring[]

The IDs of the folders to apply to the thread. This overwrites all previously assigned folders for all messages in the thread.

Example request

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

Response

Thread 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.