Update notes

Update an existing note using note ID.

Request URL


Choose domain-specific URL to replace {api-domain}

You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:

  • For US, https://www.zohoapis.com
  • For EU, https://www.zohoapis.eu
  • For AU, https://www.zohoapis.com.au
  • For IN, https://www.zohoapis.in
  • For CN, https://www.zohoapis.com.cn
  • For JP, https://www.zohoapis.jp

For more information, see Multi DC Support.



For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.

Authorization: Zoho-oauthtoken <ACCESS_TOKEN>

You must authenticate using an access token that is associated with one of the following scopes:

  • ZohoBigin.modules.ALL and ZohoBigin.modules.notes.ALL
  • ZohoBigin.modules.ALL and ZohoBigin.modules.notes.WRITE
  • ZohoBigin.modules.ALL and ZohoBigin.modules.notes.UPDATE
  • ZohoBigin.modules.{module_name}.ALL and ZohoBigin.modules.notes.ALL
  • ZohoBigin.modules.{module_name}.ALL and ZohoBigin.modules.notes.WRITE
  • ZohoBigin.modules.{module_name}.ALL and ZohoBigin.modules.notes.UPDATE
  • ZohoBigin.modules.{module_name}.WRITE and ZohoBigin.modules.notes.ALL
  • ZohoBigin.modules.{module_name}.WRITE and ZohoBigin.modules.notes.WRITE
  • ZohoBigin.modules.{module_name}.WRITE and ZohoBigin.modules.notes.UPDATE
  • ZohoBigin.modules.{module_name}.UPDATE and ZohoBigin.modules.notes.ALL
  • ZohoBigin.modules.{module_name}.UPDATE and ZohoBigin.modules.notes.WRITE
  • ZohoBigin.modules.{module_name}.UPDATE and ZohoBigin.modules.notes.UPDATE

In the above scope, replace {module_name} with the necessary module. The possible modules include pipelines, contacts, accounts (companies in Bigin), products, calls, events, and tasks.

Request parameters

The available request parameters are given below:

Path parameters

module_api_name stringRequired

The API name of the module. The possible modules for this endpoint and their API name are given below:

ModuleAPI Name
record_id stringRequired

The unique identification of a record in a module. You can get the record ID from the Get records API.

note_id stringRequired

The unique identification of a note. You can get the note IDs from the Get notes API.


Body parameters

Note_Title stringOptional

Provide the updated title for the note.

Note_Content stringOptional

Provide the updated content for the note.

Note: Use only the Field API names in the input. To obtain the Field API names, you can make use of the Fields metadata API. Look for the value corresponding to the key api_name for each field.

Sample request

Copiedcurl "https://www.zohoapis.com/bigin/v2/Pipelines/2034020000000478332/Notes/2034020000000724056" \
-X PUT \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf" \
-d "@updatenote.json"
Copiednote1 = Map();
note1.put("Note_Title", "Contacted");
note1.put("Note_Content", "Tracking done. Happy with the customer");

dataList = List();

params = Map();
params.put("data", dataList);

response = invokeurl
	url :"https://www.zohoapis.com/bigin/v1/Contacts/692969000000981055/Notes/692969000000994147"
	type :PUT
	parameters: params.toString()
info response;

Sample request body

Copied//Consider the following data is saved in a file 'updatenote.json'
			"Note_Title": "Arrival date",
			"Note_Content": "5th December 2023"

Response object

The response object provides information regarding the success message or status.

Possible error codes

The response of this resource includes HTTP status and error codes.

The most common HTTP error codes that occur when you request access to this endpoint are given in the following:


    The module name given seems to be invalid
    Resolution: You have specified an invalid module name or there is no tab permission, or the module could have been removed from the available modules. Specify a valid module API name.


    The given module is not supported in API
    Resolution: The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are been supported). Specify a valid module API name.


    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.


    Resolution: Client does not have ZohoBigin.modules.notes.UPDATE scope. Create a new client with valid scope. Refer to scope section above.


    Permission denied to update notes details
    Resolution: The user does not have permission to update notes data. Contact your system administrator.


    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.


    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.


    User does not have sufficient privilege to update notes
    Resolution: The user does not have the permission to update notes data. Contact your system administrator.


    the related id given seems to be invalid
    Resolution: You have specified an incorrect related record ID. Please specify a valid record ID. Refer to Get Related Records API to get valid record IDs.


    required field not found
    Resolution: You have not specified one or more mandatory fields in the input. Refer to Fields Metadata API to know the mandatory fields.

Sample response

    "data": [
            "code": "SUCCESS",
            "details": {
                "Modified_Time": "2023-07-23T01:19:26+05:30",
                "Modified_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
                "Created_Time": "2023-07-22T23:35:28+05:30",
                "id": "2034020000000724056",
                "Created_By": {
                    "name": "Zylker Travels",
                    "id": "2034020000000457001"
            "message": "record updated",
            "status": "success"