Update Notes
Purpose
To update an existing note.
Request Details
Request URL
{api-domain}/crm/{version}/Notes
To update a specific note:
{api-domain}/crm/{version}/Notes/{note_id}
To update notes of a specific record:
{api-domain}/crm/{version}/{module_api_name}/{record_id}/Notes
Supported modules
Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Appointments, Services and Custom
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.modules.ALL
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}
(and)
scope=ZohoCRM.modules.notes.{operation_type}
Possible module names
leads, accounts, contacts, deals, campaigns, tasks, events, calls, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, appointments, services and custom
Possible operation types
ALL - Full access to notes
WRITE - Edit note data
UPDATE - Update note data
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v6/Notes/4150868000002975099"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@updatenote.json"
-X PUT
Copiednote1 = Map();
note1.put("Note_Title", "Contacted");
note1.put("Note_Content", "Tracking done. Happy with the customer");
dataList = List();
dataList.add(note1);
params = Map();
params.put("data", dataList);
response = invokeurl
[
url :"https://www.zohoapis.com/crm/v6/Leads/692969000000981055/Notes/692969000000994147"
type :PUT
parameters: params.toString()
connection:"crm_oauth_connection"
];
info response;
In the request, "@updatenote.json" contains the sample input data.
Request JSON Keys
- Note_Titlestring, optional
Specify the updated title of the note.
- Note_Contentstring, optional
Specify the updated content of the note.
Note
- You must use only Field API names in the input. You can obtain the field API names from Fields metadata API (the value for the key “api_name” for every field).
- You can update a maximum of 100 notes per API call.
- You can update only two fields of a note: Note_Title and Note_Content. You cannot update values for the following read_only fields: Owner, Modified_Time, Created_Time, Modified_By, and Created_By.
Sample Input
Copied{
"data": [
{
"Note_Title": "Contacted",
"Note_Content": "Tracking done. Happy with the customer"
}
]
}
In the input, specify the field API names of the Notes module along with the corresponding values.
Possible Errors
- INVALID_MODULEHTTP 400
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. - INVALID_MODULEHTTP 400
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. - INVALID_URL_PATTERNHTTP 404
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. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.modules.notes.UPDATE scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to update notes details
Resolution: The user does not have permission to update notes data. Contact your system administrator. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team. - INVALID_REQUEST_METHODHTTP 400
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. - AUTHORIZATION_FAILEDHTTP 400
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. - INVALID_DATAHTTP 400
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. - MANDATORY_NOT_FOUNDHTTP 400
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
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"created_time": "2016-07-05T17:13:24+05:30",
"modified_time": "2016-08-08T11:28:41+05:30",
"modified_by": {
"name": "Patricia Boyle",
"id": "4108880000086001"
},
"id": "410888000000643123",
"created_by": {
"name": "Patricia Boyle",
"id": "4108880000086001"
}
},
"message": "record updated",
"status": "success"
}
]
}