Delete a Note

Purpose

This API is used to delete a note.

OAuth Scope

Use the scope

ZohoMail.notes.ALL (or) ZohoMail.notes.DELETE

to generate the Authtoken.

ALL - Grants full access to notes.

DELETE - Grants access to delete in notes.

Request URL

Method: DELETE

Group Notes:

https://mail.zoho.com/api/notes/groups/{groupId}/{noteId}

or

Personal Notes:

https://mail.zoho.com/api/notes/me/{noteId}

Path Parameters

  • groupId* long
    • Specify the unique ID  of the group.
    • This parameter can be retrieved from the Get all groups API.
  • noteId* long
    • Specify the unique ID of the note to be updated.
    • This parameter can be retrieved from the Get all notes API.

Query Parameters

  • forceDelete boolean
    • This parameter specifies whether the note has be deleted permanently or moved to the trash folder.
    • Allowed values :
      • true - The note will be deleted permanently without moving it to the trash folder.
      • false - The note will be moved to the trash folder.
    • Default value : true.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request - Group Notes

Copiedcurl "https://mail.zoho.com/api/notes/groups/12345678/1711534801314110001" \
-X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

Sample Request - Personal Notes

Copiedcurl "https://mail.zoho.com/api/notes/me/1711534801314110001" \
-X DELETE \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"

Sample Success Response

Copied{
"status": {
"code": 200,
"description": "success"
}
}

Sample Failure Response

Copied{
  "status": {
    "code": 500,
    "description": "Operation not permitted"
  },
  "data": {}
}