Create New Candidate
POST
/candidates
Last modified:2024-08-09 12:12:50
Maintainer:Not configured
{ “response”: { “candidate_ref”:”XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX” “candidate_id”:”” } }where,
candidate_ref is a UUID string, identifying the candidate uniquely at HB.
candidate_id is an integer ID string, used internally by the portal to identify the candidate uniquely at HB when accessing candidate information via the portal.
If the candidate has already been created previously, based on matching email addresses, then the response should be HTTP 202 Accepted2 , and the message body should be the same as in case of HTTP 201 Created. The candidate details will not be updated in this case. The alternative candidate edit method should be used
instead.
Request
Header Params
Body Params application/x-www-form-urlencoded
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/candidates' \
--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=email@domain.co.uk' \
--data-urlencode 'client_record_ref=Text' \
--data-urlencode 'consultant_name=Text' \
--data-urlencode 'activate_candidate=1' \
--data-urlencode 'archived=0' \
--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='Response Response Example
[
{
"response": {
"candidate_ref": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"candidate_id": 0000000
}
}
]Modified at 2024-08-09 12:12:50