Change Status

Purpose

To change the status of a Candidate or Job Opening.

Request URL

https://recruit.zoho.com/recruit/v2/{module_api_name}/status

For Offers;
​https://recruit.zoho.com/recruit/v2/{module_api_name}/{offer_id}/actions/status

module_api_name - The API name of the module
offer_id - The unique ID of the offer

Note:

For the Offers module, Change Status is only allowed for one record at a time.

Request Method

PUT

Scope

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

Possible module namesPossible operation types
candidate, application, jobopening, and offerALL - Full access to the record
UPDATE - Update records in the module

Sample Input #1

Copied{
    "data": [
        {
            "ids": ["568998000001714001"],
            "Candidate_Status": "New",
            "comments": "Status updated to New"
 }]
}

Sample Input #2

Copied{
    "data": [
        {
            "ids": [
                "100006000000026741"
            ],
            "jobids": [
                "100006000000026844"
            ],
            "Candidate_Status": "Qualified",
            "comments": "Associated with Java Developer"
        }
    ]
}

Sample Response

Copied{
   "data": [
       [
           {
               "code": "SUCCESS",
               "details": {
                   "Modified_Time": "2021-02-02T06:38:24+00:00",
                   "Modified_By": {
                       "name": "Patricia Boyle",
                       "id": "568998000000277007"
                   },
                   "Created_Time": "2021-02-02T06:38:18+00:00",
                   "id": "568998000001714001",
                   "Created_By": {
                       "name": "Patricia Boyle",
                       "id": "568998000000277007"
                   }
               },
               "message": "status changed",
               "status": "success"
           }
       ]
   ]
}