Request Details

Request URL

https://www.zohoapis.com/bigin/v1/Notes?ids={Entity_ID1, Entity_ID2, Entity_ID3,..}

To delete a specific note:
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
DELETE - Delete note data

Parameters

  • idsstring, mandatory when deleting multiple notes

    Specify the unique IDs of the notes to be deleted.

Sample Request

Copiedcurl "https://www.zohoapis.com/bigin/v1/Notes?ids=2883756000000268003,2883756000000987654,2883756000000736435"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X DELETE
CopiedZBiginRecord recordIns = ZBiginRecord.getInstance("Contacts", 3719520000000326007L); //module api name with record id
ZBiginNote note = ZBiginNote.getInstance(recordIns, 3719520000000482003L); //record instance with note id
APIResponse response = recordIns.deleteNote(note);ZBiginNote updatedNote = (ZBiginNote)response.getData();
Copieddef delete_note(self):
        try:
            record = ZBiginRecord.get_instance('Contacts', 3719520000000326007)
            note_ins = ZBiginNote.get_instance(record, 3719520000000512001)
            resp = record.delete_note(note_ins)
            print(resp.status_code)
            print(resp.code)
            print(resp.details)
            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)
CopiedZBiginRecord recordIns = ZBiginRecord.GetInstance("Contacts", 3372164000000614001); //module api name with record id
ZBiginNote note = ZBiginNote.GetInstance(recordIns, 3372164000001369220); //record instance with note id
APIResponse response = recordIns.DeleteNote(note);
ZBiginNote updatedNote = (ZBiginNote)response.Data;
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v1/Notes?ids=2883756000000268003,2883756000000987654,2883756000000736435"
	type: DELETE
	connection:"bigin_oauth_connection"
];
info response;

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.DELETE scope. Create a new client with valid scope. Refer to scope section above.

  • NO_PERMISSIONHTTP 403

    Permission denied to delete notes details
    Resolution: The user does not have permission to delete 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 delete notes
    Resolution: The user does not have the permission to delete notes data. Contact your system administrator.

  • INVALID_DATAHTTP 202

    record not deleted
    Resolution: The note ID specified in the URL is invalid. Refer to Get Notes API to get valid note IDs.

  • UNABLE_TO_PARSE_DATA_TYPEHTTP 400

    either the request body or parameters is in wrong format
    Resolution: The parameter values are in the wrong format. Specify valid record IDs in the correct format. Refer to endpoints section above.

  • REQUIRED_PARAM_MISSINGHTTP 400

    One of the expected parameter is missing
    Resolution: 'ids' parameter is missing in the request. Please specify the IDs of the notes to be deleted. Refer to Get Notes Data API to get valid record IDs.

Sample Response

Copied{
    "data": [
       {
            "code": "SUCCESS",
            "details": {
                "id": "2883756000000308033"
            },
            "message": "record deleted",
            "status": "success"
        },
       {
            "code": "SUCCESS",
            "details": {
                "id": "2883756000000308027"
            },
            "message": "record deleted",
            "status": "success"
        },
       {
            "code": "SUCCESS",
            "details": {
                "id": "2883756000000308021"
            },
            "message": "record deleted",
            "status": "success"
        }
    ]
}