Public API Reference (Beta)Applicants/CandidatesCore

Create an applicant

Authentication

X-Brightmove-Company-ApiKeystring
BrightMove Company Api Key
X-Brightmove-User-ApiKeystring
BrightMove User Api Key

Request

This endpoint expects an object.
firstNamestringRequired
Applicant's first name.
lastNamestringRequired
Applicant's last name.
emailstringRequired
Applicant's personal email address.
middleNamestringOptional
Applicant's middle name or initial.
workEmailstringOptional
Applicant's work email address.
addressstringOptional
Street address line 1.
address2stringOptional

Street address line 2 (apartment, suite, etc.).

citystringOptional
City.
stateIdlongOptional

State ID from the BrightMove state lookup. Use GET /api/v1/lookup/states to retrieve valid IDs.

postalCodestringOptional
Postal code.
currentCompanystringOptional
Applicant's current or most recent employer.
currentTitlestringOptional
Applicant's current or most recent job title.
primarySkillsstringOptional

Comma-separated list of the applicant’s primary skills.

confidentialbooleanOptional

When true, marks this applicant as confidential. Viewing confidential applicants requires the VIEW_APPLICANT_CONFIDENTIAL permission.

emailAllowedbooleanOptional
When true, the applicant has opted in to email communications.
smsAllowedbooleanOptional

When true, the applicant has opted in to SMS/text message communications.

recruiterGuidstringOptional
GUID of the recruiter to assign to this applicant. Pass an empty string to remove the current assignment.
sourcestringOptional

Applicant source name exactly as configured for your company (e.g. ‘LinkedIn’, ‘Referral’). If omitted, the company default source is used.

Response

Created