Update an applicant

Authentication

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

Path parameters

guidstringRequired

Request

This endpoint expects an object.
firstNamestringOptional
Applicant's first name.
middleNamestringOptional
Applicant's middle name or initial.
lastNamestringOptional
Applicant's last name.
emailstringOptional
Applicant's personal email address.
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 (ZIP) 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.

sourcestringOptional

Applicant source name exactly as configured for your company (e.g. ‘LinkedIn’, ‘Referral’).

recruiterGuidstringOptional

GUID of the recruiter (BrightMove user) to assign to this applicant. Pass an empty string to remove the current assignment.

Response

OK