Edit a Book in Notes

Purpose

This API is used to edit a book in notes.

OAuth Scope

Use the scope

ZohoMail.notes.ALL (or) ZohoMail.notes.UPDATE

to generate the Authtoken.

ALL - Grants full access to notes.

UPDATE - Grants access to edit in notes.

Request URL

Method: PUT

Group Notes:

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

or

Personal Notes:

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

Path Parameters

  • groupId* long
    • Specifies the unique ID of the group.
    • This parameter can be retrieved from the Get all groups API.
  • bookId* long
    • Specifies the unique ID of the book.
    • This parameter can be retrieved from the Get all books API.

Request Body ( JSON Object)

  • bookName* string
    • Provide a new name for the book.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request - For Group Notes

Copiedcurl "https://mail.zoho.com/api/notes/groups/123456789/books/3764869000000008001" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"\
-d '{
 "bookName": "notebook2"
 }'

Sample Request - For Personal Notes

Copiedcurl "https://mail.zoho.com/api/notes/me/books/3764869000000008001" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken *****"\
-d '{
 "bookName": "notebook2"
 }'

Sample Success Response

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

Sample Failure Response

Copied{
  "data": {
    "errorCode": "INVALID_METHOD"
  },
  "status": {
    "code": 404,
    "description": "Invalid Input"
  }
}