Update Candidate Details

PATCH

/candidates/{{candidate_ref}}

Maintainer:Not configured

The request is HTTP PATCH (RFC 5789), application/x-www-form-urlencoded or multipart/form-data (RFC7578) and holds the updated details of the candidate. This is a partial update call, which does not update every detail every time, only the modified ones. The available data fields are listed in Appendix 4.2.
If the operation was successful, the response message is HTTP 200 OK. If the request but the data was unchanged, the response message is HTTP 304 Unchanged. If the request cannot be processed due to misformatted or untranslatable data, the API should response with HTTP 400 Bad Request error.
If the candidate_ref is not valid then the API should response with HTTP 404 Not Found error.
If the request cannot be processed due to data validation errors, the API should respond with HTTP 403 Forbidden and an appropriate error response. (See section 3.6 Error responses).

Request

Authorization

Add parameter in header

API-Key

Example:

API-Key: ********************

Header Params

Body Params application/x-www-form-urlencoded

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request PATCH '/candidates/{{candidate_ref}}' \
--header 'Accept: application/json' \
--header 'API-Version: {{api_version}}' \
--header 'API-Key: <api-key>' \
--data-urlencode 'first_name=First Name' \
--data-urlencode 'last_name=Last Name' \
--data-urlencode 'email=email11@domain.co.uk' \
--data-urlencode 'client_record_ref=Text' \
--data-urlencode 'consultant_name=Text' \
--data-urlencode 'activate_candidate=1' \
--data-urlencode 'archived=1' \
--data-urlencode 'form_set=' \
--data-urlencode 'return_email=' \
--data-urlencode 'send_activation_mail=' \
--data-urlencode 'clearance_type=' \
--data-urlencode 'job_role=' \
--data-urlencode 'documents_required=' \
--data-urlencode 'document_list='

Responses

🟢200Update Candidate Details

application/json

Body

Example

[
    ""
]

Modified at 2024-08-09 12:13:06

Create New Candidate

Get Available Trainings