candidate.update

post

https://api.ashbyhq.com/candidate.update

Updates an existing candidate.

Requires the candidatesWrite permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

candidateId

uuid

required

The unique id of the candidate to update

name

The first and last name of the candidate to update

Primary, personal email of the candidate to update

phoneNumber

Primary, personal phone number of the candidate to update

linkedInUrl

Url to the candidate's LinkedIn profile. Must be a valid Url.

githubUrl

Url to the candidate's Github profile. Must be a valid Url.

websiteUrl

Url of the candidate's website. Must be a valid Url.

alternateEmail

An alternate email address to add to the candidate's profile

socialLinks

array | null

An array of social links to set on the candidate. This value replaces existing socialLinks that have been set on the candidate. If this value is submitted along with linkedInUrl, gitHubUrl or websiteUrl fields, those values will be ignored.

sourceId

The id of source for this candidate

creditedToUserId

The id of the user the candidate will be credited to

location

object | null

The location of the candidate

createdAt

An ISO date string to set the candidate's createdAt timestamp

sendNotifications

Whether or not users who are subscribed to the candidate should be notified that the candidate was updated. Default is true.

Response

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Responses from the candidate.update endpoint