Create Notes
Purpose
To add new notes.
Request Details
Request URL
https://www.zohoapis.com/bigin/v1/Notes
To add notes for a specific record:
https://www.zohoapis.com/bigin/v1/{module_api_name}/{record_id}/Notes
Possible module names
Accounts (Companies in Bigin), Contacts, Deals, Tasks, Events, Calls and Products
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoBigin.modules.ALL
(or)
scope=ZohoBigin.modules.{module_name}.{operation_type}
(and)
scope=ZohoBigin.modules.notes.{operation_type}
Possible module names
accounts(companies in Bigin), contacts, deals, tasks, events, calls, events, calls and products
Possible operation types
ALL - Full access to notes
WRITE - Edit note data
CREATE - Create note data
Sample Request
Copiedcurl "https://www.zohoapis.com/bigin/v1/Contacts/1000000145990/Notes"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@newnote.json"
-X POST
CopiedZBiginRecord record = ZBiginRecord.getInstance("Products",23857634545l);//module api name with record id
ZBiginNote note = new ZBiginNote(record);
note.setContent("test msg");
note.setTitle("test class notes");
APIResponse response = record.addNote(note);
ZBiginNote createdNote = (ZBiginNote) response.getData();
String recStatus =response.getStatus();
Copiedtry{
$record=ZBiginRecord::getInstance('Accounts',410405000000497012);
$noteIns=ZBiginNote::getInstance($record);
$noteIns->setTitle("Title_API1");
$noteIns->setContent("This is test content");
$responseIns=$record->addNote($noteIns);
$zbiginNote=$responseIns->getData();
echo "HTTP Status Code:".$responseIns->getHttpStatusCode();
echo "Status:".$responseIns->getStatus();
echo "Message:".$responseIns->getMessage();
echo "Code:".$responseIns->getCode();
echo "Details:".$responseIns->getDetails()['id'];
echo "Entity Id:".$zbiginNote->getId();
}
catch (ZBiginException $e)
{
echo $e->getCode();
echo $e->getMessage();
echo $e->getExceptionCode();
}
Copieddef add_note(self):
try:
record = ZBiginRecord.get_instance('Contacts', 3719520000000326007)
note_ins = ZBiginNote.get_instance(record, None)
note_ins.title = "title2"
note_ins.content = 'content2...'
resp = record.add_note(note_ins)
print(resp.status_code)
print(resp.code)
print(resp.data.id)
print(resp.message)
print(resp.status)
except ZBiginException as ex:
print(ex.status_code)
print(ex.error_message)
print(ex.error_code)
print(ex.error_details)
print(ex.error_content)
Copiednote1 = Map();
note1.put("Note_Title", "Contacted");
note1.put("Note_Content", "Need to do further tracking");
note1.put("Parent_Id", "692969000000981055");
note1.put("se_module", "Contacts");
dataList = List();
dataList.add(note1);
params = Map();
params.put("data", dataList);
response = invokeurl
[
url :"https://www.zohoapis.com/bigin/v1/Notes"
type :POST
parameters: params.toString()
connection:"bigin_oauth_connection"
];
info response;
In the request, "@newnote.json" contains the sample input data.
Request JSON Keys
- Note_Titlestring, optional
Specify the title of the note.
- Note_Contentstring, mandatory
Specify the content of the note.
- Parent_Idstring, mandatory
Specify the unique ID of the parent record. Refer to Get Records API to get valid record IDs.
- se_modulestring, mandatory
Specify the module API name of the parent module. Refer to Modules API to get valid module API names.
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).
Sample Input
Copied{
"data": [
{
"Note_Title": "Contacted",
"Note_Content": "Need to do further tracking",
"Parent_Id": "412963000001376069",
"se_module": "Contacts"
}
]
}
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 ZohoBigin.modules.notes.CREATE scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to add notes details
Resolution: The user does not have permission to add 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 add notes
Resolution: The user does not have the permission to add 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 202
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": [
{
"message": "record added",
"details": {
"created_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"id": "410888000000737002",
"modified_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"modified_time": "2016-09-16T12:15:13+05:30",
"created_time": "2016-09-16T12:15:13+05:30"
},
"status": "success",
"code": "SUCCESS"
}
]
}