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
        • DELDelete Applicant Reference
        • GETGet Applicant References
        • POSTPersist Applicant Reference
    • Clients/Departments
    • Contacts/Managers
LogoLogo
Get SupportGet a demo
Internal API ReferenceApplicants/CandidatesReferences

Persist Applicant Reference

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

Delete An Applicant Employment History Record

Next
Built with

Headers

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

Request

This endpoint expects an object.
referenceGklongOptional
referenceNamestringOptional
companyNamestringOptional
phonestringOptional
emailstringOptional
commentsstringOptional
contactDatedatetimeOptional
employeeGklongOptional
createUserGklongOptional
employeeNamestringOptional
applicantGklongOptional
verifiedbooleanOptional
sectionslist of objectsOptional

Response

OK