PUT - Edit a Note

Purpose

This API is used to make changes to any Note.

Request URL 

Group Notes

https://mail.zoho.com/api/notes/groups/<groupid>/<entityId>

Personal Notes

https://mail.zoho.com/api/notes/me/<entityId>

Request Parameters

ParameterData TypeDescription
GroupID*LongThe unique identifier used for groups in the organization
EntityID*IntegerThe unique identifier used for a note

* - Mandatory parameters

Request Body (JSON Object)

ParameterData TypeDescription
titleStringThe title for the note that is being edited
contentStringThe content for the note that is being edited
bookIdLongThe unique ID of the book of the note
colorIntegerThe unique identifier used to denote the color of a note
(Notes color code: 0 - blue, 1 - green, 2 - yellow, 3 - red))

* - Mandatory parameters

Response Codes

Please refer Response Codes.

Group Notes

Sample Request

Copiedhttps://mail.zoho.com/api/notes/groups/1726251/36000000037002

Sample Request Body

Copied{
    "title": "Manager's meeting",
    "content": "Agenda for the meeting:
    1. Roadmap for the next quarter
    2. Talk about the design process
    3. How do we improve the onboarding? 
    4. Should we expand the support team?",
    "bookId": "36000000002001",
    "color": "1"
}

Sample Response

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

Personal Note

Sample Request

Copiedhttps://mail.zoho.com/api/notes/me/36000000037002

Sample Request Body

Copied{
    "title": "Manager's meeting",
    "content": "Agenda for the meeting:
    1. Roadmap for the next quarter
    2. Talk about the design process
    3. How do we improve the onboarding? 
    4. Should we expand the support team?",
    "bookId": "36000000002001",
    "color": "1"
}

Sample Response

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