Update Notes

Purpose

To update an existing note in your Zoho Recruit account uing API.

Request URL

https://recruit.zoho.com/recruit/v2/Notes

Request Method

PUT

Scope

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

Supported Modules	Possible operation types
candidate, jobopenings, Interview, client, contact, department, task, event, vendor custommodule	ALL - Full access to notes WRITE - Edit note data UPDATE - Update note data

Possible Errors

HTTP Status	Error	Message	Reason
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.
202	MANDATORY_NOT_FOUND	required field not found	You have not specified one or more mandatory fields in the input.

Sample Request

Copiedcurl "https://recruit.zoho.com/recruit/v2/Notes/4150868000002975099"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@updatenote.json"
-X PUT

In the request, "@updatenote.json" contains the sample input data.

Sample Input

Copied{
    "data": [
       {
            "Note_Title": "Qualified",
            "Note_Content": "Screening done. Happy with the candidate"
        }
    ]
}

In the input, specify the field API names of the Notes module along with the corresponding values.

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