Revoke Blueprint

Purpose

To remove the specified record from the blueprint process it is part of.

Request URL

https://recruit.zoho.com/recruit/v2/{module_api_name}/{record_id}/blueprint/revoke

module_api_name - The API name of the module
record_id - The unique Id of the record

Request Method

PUT

Scope

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

Possible module names
candidates, job_opening, interview, client, contact, department, vendor, application, task, event, referral

Parameters

Parameter NameData TypeDescriptionPossible Values
record_idNumberThe unique ID of the specified recordEntity IDs separated by commas.
For example: 410405000002264040, 410405000002264025

Possible Errors

HTTP Status CodeError CodeError MessageReason
400INVALID_MODULE

The module name given seems to be invalid

The module name specified in the API request might have been invalid or removed from the account.

400INVALID_MODULE

The given module is not supported in API

For modules such as Documents and Projects, the current API will not be supported. (Support will be added soon)

400RECORD_LOCKED

Record is Locked for Processing in GDPR

The entity has either been Restricted or Opted-Out via GDPR. 

202CANNOT_PERFORM_ACTION

Record is not part of any Blueprint Processes.

The record id included in the API request does not seem to be part of any blueprint processes.

Sample Request

Copiedcurl--location--request PUT 'https://recruit.zoho.com/recruit/v2/Candidates/22688000000880234/blueprint/revoke?job_opening_id=22688000000748546'\
    --header 'Authorization: Zoho-oauthtoken 1000.47c945a511b3b5193b89ba301f08d9a0.c5743a1d3e2ec074254509d94b006617'