For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get SupportGet a demo
  • Get Started
    • Welcome
    • Quickstart
  • Webhooks
    • Introduction
    • Creating a Webhook
    • Available Webhooks
  • Public API Reference (Beta)
    • Applicants/Candidates
    • Contacts/Managers
    • Clients/Departments
  • Internal API Reference
    • Applicants/Candidates
        • POSTCheck for Duplicate Applicants
        • POSTCopy and Import an Applicant
        • POSTCopy and Import an Applicant
        • DELDelete an Applicant
        • GETGet a Lightweight Applicant
        • POSTGet a list of Applicants
        • GETGet an Applicant
        • POSTGet Applicant Rate Card
        • POSTPersist an Applicant
    • Clients/Departments
    • Contacts/Managers
LogoLogo
Get SupportGet a demo
Internal API ReferenceApplicants/CandidatesCore

Persist an Applicant

POST
https://app.brightmove.com/ATS/app/appl
POST
/ATS/app/appl
$curl -X POST https://app.brightmove.com/ATS/app/appl \
>     -H "Content-Type: application/json" \
>     -d '{}'
200Successful
1{}
Creates a new Applicant or updates an existing Applicant
Was this page helpful?
Previous

Add Resume with File

Next
Built with

Headers

X-Brightmove-Company-ApiKeystringOptional
X-Brightmove-User-ApiKeystringOptional

Request

This endpoint expects an object.
userGklongOptional
guidstringOptional
salutationobjectOptional
firstNamestringOptional
middleNamestringOptional
lastNamestringOptional
nicknamestringOptional
emailstringOptional
workEmailstringOptional
typeobjectOptional
companyGklongOptional
companyNamestringOptional
companyGuidstringOptional
createUserGklongOptional
modifyUserGklongOptional
usernamestringOptional
avatarUrlstringOptional
timezoneIdintegerOptional
localeIdintegerOptional
statusIdintegerOptional
phoneslist of objectsOptional
primarybooleanOptional
createUserobjectOptional
modifyUserobjectOptional
createDatedatetimeOptional
modifyDatedatetimeOptional
themeGklongOptional
lookDatedatetimeOptional
unsubscribeDatedatetimeOptional
delegateslist of objectsOptional
emailSignaturestringOptional
addressstringOptional
address2stringOptional
citystringOptional
stateobjectOptional
postalCodestringOptional
sourceobjectOptional
statusobjectOptional
employmentTypeobjectOptional
emailAllowedbooleanOptional
smsAllowedbooleanOptional
doNotHirebooleanOptional
preferredLocationstringOptional
availableDatedatetimeOptional
availabilityCommentsstringOptional
referredBystringOptional
currentCompanystringOptional
currentTitlestringOptional
currentPaydoubleOptional
currentPayTypeobjectOptional
desiredPaydoubleOptional
desiredPayTypeobjectOptional
payCommentsstringOptional
taxIdintegerOptional
dobdatetimeOptional
recruiterobjectOptional
disabilityStatusobjectOptional
currentEmployeebooleanOptional
sourceOtherstringOptional
rankintegerOptional
primarySkillsstringOptional
genderobjectOptional
raceEthnicityobjectOptional
veteranStatusobjectOptional
workPermitobjectOptional
newResumebooleanOptional
confidentialbooleanOptional
resumeslist of objectsOptional
udfSectionslist of objectsOptional
employmentHistorylist of objectsOptional
educationlist of objectsOptional
employerstringOptional
applStatNamestringOptional
titlestringOptional
statusNotestringOptional
socialLinkslist of objectsOptional
ownedByMasterCompanybooleanOptional
linkedContactobjectOptional
vendorobjectOptional
linkClientContactGklongOptional
tagslist of objectsOptional
personalDataobjectOptional
sensitiveDataobjectOptional
duplicatebooleanOptional
attachmentslist of objectsOptional
overridebooleanOptional
visitorIdstringOptional
ssnstringOptional
namestringOptional
displayFullNamestringOptional
displayNamestringOptional
displayNameLastFirststringOptional
bestEmailstringOptional

Response

OK