Update Notes

Purpose

To update an existing note.

Request Details

Request URL

https://www.zohoapis.com/bigin/v1/{module_api_name}/{record_id}/Notes/{note_id}

Supported Modules

Modules supported in Get List of Attachments are supported here.

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

companies, contacts, deals, tasks, events, calls, products and activities

Possible operation types

ALL - Full access to notes
WRITE - Edit note data
UPDATE - Update note data

Sample Request

Copiedcurl "https://www.zohoapis.com/bigin/v1/Contacts/410888000000645234/Notes/410888000000643123"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@updatenote.json"
-X PUT
CopiedZBiginRecord record = ZBiginRecord.getInstance("Products",23857634545l);//module api name with record id
ZBiginNote note = ZBiginNote.getInstance(record,374968745l);// notesID
note.setContent("update message");
APIResponse response = record.updateNote(note);
ZBiginNote updatedNote = (ZBiginNote) response.getData();
String recStatus =response.getStatus();
Copiedtry{
$record=ZBiginRecord::getInstance('Accounts',410405000000497012); // 410405000000497012 - Account ID.
$noteIns=ZBiginNote::getInstance($record,410405000000498056); // , 410405000000498056 - Note ID
$noteIns->setTitle("Title_API22..");
$noteIns->setContent("This is test content");
$responseIns=$record->updateNote($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 update_note(self):
        try:
            record = ZBiginRecord.get_instance('Contacts', 3719520000000326007)  # module API Name, entityId
            note_ins = ZBiginNote.get_instance(record, 3719520000000512001)  # note ID
            note_ins.title = "title2 updated"
            note_ins.content = 'content2 updated...'
            resp = record.update_note(note_ins)
            print(resp.status_code)
            print(resp.code)
            print(resp.data.modified_by.id)
            print(resp.data.modified_by.name)
            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", "Tracking done. Happy with the customer");

dataList = List();
dataList.add(note1);

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

response = invokeurl
[
	url :"https://www.zohoapis.com/bigin/v1/Contacts/692969000000981055/Notes/692969000000994147"
	type :PUT
	parameters: params.toString()
	connection:"bigin_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).

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 ZohoBigin.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 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": [
       {
            "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"
        }
    ]
}