Delete a message

Deletes the specified message. If hard_delete is not defined or is false, Nylas moves the message to the user's Trash folder.

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

Query parameters

hard_deleteboolean

When true, Nylas immediately deletes the specified message instead of sending it to the user's Trash folder. This operation is irreversible.

To use this query parameter, you need to turn on "Enable hard delete" in the Nylas Dashboard under Customizations > API.

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.

Response

Delete Succeeded

request_idstring required

ID of the request.

Example response

{
  "request_id": "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90"
}

Changes

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