Create Specific Notes
Purpose
To add new notes to a particular record.
Request URL
https://www.zohoapis.com/crm/v2/{module_api_name}/{record_id}/Notes
module_api_name - The API name of the module
record_id - The unique ID of the record
Modules supported in Get a Specific Note are supported here.
Request Method
POST
Scope
scope=ZohoCRM.modules.all
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}
(and)
scope=ZohoCRM.modules.notes.CREATE
Possible module names | Possible operation types |
---|---|
leads, accounts, contacts, deals, campaigns, tasks, events, calls, cases, events, calls, solutions, products, vendors, pricebooks, quotes, salesorders, purchaseorders, invoices, and custom | ALL - Full access to notes WRITE - Edit note data CREATE - Create note data |
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).
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v2/Leads/1000000145990/Notes"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@newnote.json"
-X POST
CopiedZCRMRecord record = ZCRMRecord.getInstance("Products",23857634545l);//module api name with record id
ZCRMNote note = new ZCRMNote(record);
note.setContent("test msg");
note.setTitle("test class notes");
APIResponse response = record.addNote(note);
ZCRMNote createdNote = (ZCRMNote) response.getData();
String recStatus =response.getStatus();
Copiedtry{
$record=ZCRMRecord::getInstance('Accounts',410405000000497012);
$noteIns=ZCRMNote::getInstance($record);
$noteIns->setTitle("Title_API1");
$noteIns->setContent("This is test content");
$responseIns=$record->addNote($noteIns);
$zcrmNote=$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:".$zcrmNote->getId();
}
catch (ZCRMException $e)
{
echo $e->getCode();
echo $e->getMessage();
echo $e->getExceptionCode();
}
Copied def add_note(self):
try:
record = ZCRMRecord.get_instance('Leads', 3719520000000326007)
note_ins = ZCRMNote.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 ZCRMException as ex:
print(ex.status_code)
print(ex.error_message)
print(ex.error_code)
print(ex.error_details)
print(ex.error_content)
Sample Response
Copied{
"data": [
{
"Note_Title": "Contacted",
"Note_Content": "Need to do further tracking"
}
]
}
Copied{
"data": [
{
"message": "record added",
"details": {
"created_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"id": "410888000000737004",
"modified_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"modified_time": "2016-09-16T12:19:22+05:30",
"created_time": "2016-09-16T12:19:22+05:30"
},
"status": "success",
"code": "SUCCESS"
}
]
}
Copied{
"data": [
{
"Note_Title": "Contacted",
"Note_Content": "Need to do further tracking"
}
]
}
Copied{
"data": [
{
"message": "record added",
"details": {
"created_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"id": "410888000000737004",
"modified_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"modified_time": "2016-09-16T12:19:22+05:30",
"created_time": "2016-09-16T12:19:22+05:30"
},
"status": "success",
"code": "SUCCESS"
}
]
}
Copied{
"data": [
{
"Note_Title": "Contacted",
"Note_Content": "Need to do further tracking"
}
]
}
Copied{
"data": [
{
"message": "record added",
"details": {
"created_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"id": "410888000000737004",
"modified_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"modified_time": "2016-09-16T12:19:22+05:30",
"created_time": "2016-09-16T12:19:22+05:30"
},
"status": "success",
"code": "SUCCESS"
}
]
}
Copied{
"data": [
{
"Note_Title": "Contacted",
"Note_Content": "Need to do further tracking"
}
]
}
Copied{
"data": [
{
"message": "record added",
"details": {
"created_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"id": "410888000000737004",
"modified_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"modified_time": "2016-09-16T12:19:22+05:30",
"created_time": "2016-09-16T12:19:22+05:30"
},
"status": "success",
"code": "SUCCESS"
}
]
}
Sample Response
Copied{
"data": [
{
"Note_Title": "Contacted",
"Note_Content": "Need to do further tracking"
}
]
}
Copied{
"data": [
{
"message": "record added",
"details": {
"created_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"id": "410888000000737004",
"modified_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"modified_time": "2016-09-16T12:19:22+05:30",
"created_time": "2016-09-16T12:19:22+05:30"
},
"status": "success",
"code": "SUCCESS"
}
]
}
Copied{
"data": [
{
"Note_Title": "Contacted",
"Note_Content": "Need to do further tracking"
}
]
}
Copied{
"data": [
{
"message": "record added",
"details": {
"created_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"id": "410888000000737004",
"modified_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"modified_time": "2016-09-16T12:19:22+05:30",
"created_time": "2016-09-16T12:19:22+05:30"
},
"status": "success",
"code": "SUCCESS"
}
]
}
Copied{
"data": [
{
"Note_Title": "Contacted",
"Note_Content": "Need to do further tracking"
}
]
}
Copied{
"data": [
{
"message": "record added",
"details": {
"created_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"id": "410888000000737004",
"modified_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"modified_time": "2016-09-16T12:19:22+05:30",
"created_time": "2016-09-16T12:19:22+05:30"
},
"status": "success",
"code": "SUCCESS"
}
]
}
Copied{
"data": [
{
"Note_Title": "Contacted",
"Note_Content": "Need to do further tracking"
}
]
}
Copied{
"data": [
{
"message": "record added",
"details": {
"created_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"id": "410888000000737004",
"modified_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"modified_time": "2016-09-16T12:19:22+05:30",
"created_time": "2016-09-16T12:19:22+05:30"
},
"status": "success",
"code": "SUCCESS"
}
]
}
Sample Response
Copied{
"data": [
{
"Note_Title": "Contacted",
"Note_Content": "Need to do further tracking"
}
]
}
Copied{
"data": [
{
"message": "record added",
"details": {
"created_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"id": "410888000000737004",
"modified_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"modified_time": "2016-09-16T12:19:22+05:30",
"created_time": "2016-09-16T12:19:22+05:30"
},
"status": "success",
"code": "SUCCESS"
}
]
}
Copied{
"data": [
{
"Note_Title": "Contacted",
"Note_Content": "Need to do further tracking"
}
]
}
Copied{
"data": [
{
"message": "record added",
"details": {
"created_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"id": "410888000000737004",
"modified_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"modified_time": "2016-09-16T12:19:22+05:30",
"created_time": "2016-09-16T12:19:22+05:30"
},
"status": "success",
"code": "SUCCESS"
}
]
}
Copied{
"data": [
{
"Note_Title": "Contacted",
"Note_Content": "Need to do further tracking"
}
]
}
Copied{
"data": [
{
"message": "record added",
"details": {
"created_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"id": "410888000000737004",
"modified_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"modified_time": "2016-09-16T12:19:22+05:30",
"created_time": "2016-09-16T12:19:22+05:30"
},
"status": "success",
"code": "SUCCESS"
}
]
}
Copied{
"data": [
{
"Note_Title": "Contacted",
"Note_Content": "Need to do further tracking"
}
]
}
Copied{
"data": [
{
"message": "record added",
"details": {
"created_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"id": "410888000000737004",
"modified_by": {
"id": "410888000000086001",
"name": "Patricia Boyle"
},
"modified_time": "2016-09-16T12:19:22+05:30",
"created_time": "2016-09-16T12:19:22+05:30"
},
"status": "success",
"code": "SUCCESS"
}
]
}