Public API ReferenceApplicants/CandidatesProfile

Add a phone number to an applicant

Adds a new phone number to this applicant.

phoneTypeId must be a value from GET /api/v1/lookup/phone-types.

Authentication

AuthorizationBearer

BrightMove OAuth2 client_credentials - use the client_id/client_secret from User > API Keys (or an admin-managed client).

Path parameters

guidstringRequired
Stable public identifier of the applicant

Request

This endpoint expects an object.
phoneNumberstringRequired
The phone number.
phoneTypeIdlongRequired

Numeric id of the phone type. Use GET /api/v1/lookup/phone-types to retrieve valid IDs.

Response

Phone number added