Delete Note Type

Purpose

To delete an existing note type in your Zoho Recruit account via API.

Request URL

https://recruit.zoho.com/recruit/v2/Notes/{note_id}

To delete multiple notes;
https://recruit.zoho.com/recruit/v2/Notes?ids={Entity_ID1, Entity_ID2, Entity_ID3,..}

Request Method

DELETE

Scope

scope=ZohoRecruit.modules.ALL
(or)
scope=ZohoRecruit.modules.{module_name}.{operation_type}
(and)
scope=ZohoRecruit.modules.notes.{operation_type}

Supported ModulesPossible operation types

candidate, jobopenings, Interview, client, contact, department, task, event, vendor custommodule

ALL - Full access to notes
WRITE - Edit note data
DELETE - Delete note data

Possible Errors

HTTP StatusErrorMessageReason

400

INVALID_MODULE

The module name  given seems to be invalid.

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.

400

INVALID_MODULE

The given module is not supported in API

The modules such as Documents and Projects are not supported in the current API. (This error will not be shown, once these modules are supported). Specify a valid module API name.

404

INVALID_URL_PATTERN

Please check if the URL trying to access is a correct one

The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.

401

OAUTH_SCOPE_MISMATCH

Unauthorized

Client does not have ZohoRecruit.modules.notes.CREATE scope. Create a new client with valid scope. Refer to scope section above.

403

NO_PERMISSION

Permission denied to add notes details

The user does not have permission to add notes data. Contact your system administrator.

500

INTERNAL_ERROR

Internal Server Error

Unexpected and unhandled exception in Server. Contact support team.

400

INVALID_REQUEST_METHOD

The http request method type is not a valid one

You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

400

AUTHORIZATION_FAILED

User does not have sufficient privilege to add notes

The user does not have the permission to add notes data. Contact your system administrator.

400

INVALID_DATA

the related id given seems to be invalid

You have specified an incorrect related record ID. Please specify a valid record ID.

400

UNABLE_TO_PARSE_DATA_TYPE

either the request body or parameters is in wrong format

The parameter values are in the wrong format. Specify valid record IDs in the correct format. Refer to endpoints section above.

400

REQUIRED_PARAM_MISSING

One of the expected parameter is missing

 'ids' parameter is missing in the request. Please specify the IDs of the notes to be deleted.

Sample Request

Copiedcurl "https://recruit.zoho.com/recruit/v2/Notes?ids=2883756000000268003,2883756000000987654,2883756000000736435"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X DELETE

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"
        }
    ]
}