API Reference

candidate.update

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

Updates an existing candidate

Requires the candidatesWrite permission.

To set values for custom fields on Candidates, use the customFields.setValue endpoint.

Body Params
uuid
required

The unique id of the candidate to update.

string

The first and last name of the candidate to update.

string

Primary, personal email of the candidate to update.

string

Primary, personal phone number of the candidate to update.

string

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

string

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

string

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

string

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

socialLinks
array of objects

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.

socialLinks
uuid

The id of source for this candidate.

uuid

The id of the user the candidate will be credited to.

location
object

The location of the candidate.

date-time

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

boolean
Defaults to true

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

Response

Updated 5 months ago

Language
Credentials
Basic
base64
:
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago