POST AssessmentCenter/CandidateInvite

Invite a candidate.

Request Information

URI Parameters

None.

Body Parameters

Candidate
NameDescriptionTypeAdditional information
Battery

Assessment battery to be assigned to the candidate

 globally unique identifier

Required
FullName

Candidate full name

 string

Required
EMailAddress

Candidate e-mail address

 string

None.
MobilePhoneNumber

Candidate mobile phone number

 string

None.
CandidateId

Candidate unique id at the source database.

 string

None.
Position

If the candidate is associated with a position, the candidate will be assigned the position.

 globally unique identifier

None.
SendNotification

Send notification to candidate. Default value is True

 boolean

None.
CustomMessage

Add custom message to the e-mail sending to the candidate.

 string

None.
CustomLanguage

Language of the candidate.

 Language

None.
StartDate

Candidate will be able to access the assessments after this date.

 date

None.
EndDate

Candidate will be able to access the assessments to this date.

 date

None.

Request Formats

application/json, text/json

Sample: 
{
  "Battery": "94feb557-6e28-4f1b-9555-699373b74a3f",
  "FullName": "sample string 2",
  "EMailAddress": "sample string 3",
  "MobilePhoneNumber": "sample string 4",
  "CandidateId": "sample string 5",
  "Position": "2d0cbb4b-a3bb-4767-9f55-df357c3e03e2",
  "SendNotification": true,
  "CustomMessage": "sample string 7",
  "CustomLanguage": 0,
  "StartDate": "2026-08-04T03:49:44.2073079+03:00",
  "EndDate": "2026-08-04T03:49:44.2073079+03:00"
}

application/xml, text/xml

Sample: 
<Candidate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Kardelen.API.Core.Models.AssessmentCenter">
  <Battery>94feb557-6e28-4f1b-9555-699373b74a3f</Battery>
  <CandidateId>sample string 5</CandidateId>
  <CustomLanguage>English</CustomLanguage>
  <CustomMessage>sample string 7</CustomMessage>
  <EMailAddress>sample string 3</EMailAddress>
  <EndDate>2026-08-04T03:49:44.2073079+03:00</EndDate>
  <FullName>sample string 2</FullName>
  <MobilePhoneNumber>sample string 4</MobilePhoneNumber>
  <Position>2d0cbb4b-a3bb-4767-9f55-df357c3e03e2</Position>
  <SendNotification>true</SendNotification>
  <StartDate>2026-08-04T03:49:44.2073079+03:00</StartDate>
</Candidate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CandidateInvitationResult
NameDescriptionTypeAdditional information
TrackingNumber

Candidate tracking number. It is used to to get details of assessments assigned to candidate.

 globally unique identifier

None.
AccessCode

Access Code to take assignments.

 string

None.
AccessLink

Access Link to take assignments.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "TrackingNumber": "1e7da8c1-5c8a-46ed-8ff7-310f52961620",
  "AccessCode": "sample string 2",
  "AccessLink": "sample string 3"
}

application/xml, text/xml

Sample: 
<CandidateInvitationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Kardelen.API.Core.Models.AssessmentCenter">
  <AccessCode>sample string 2</AccessCode>
  <AccessLink>sample string 3</AccessLink>
  <TrackingNumber>1e7da8c1-5c8a-46ed-8ff7-310f52961620</TrackingNumber>
</CandidateInvitationResult>