Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Candidate

candidate.create

Creates a new candidate.

Requires the candidatesWrite permission.

post/candidate.create

Request body

namestring required

The first and last name of the candidate to be created

emailstring nullable

Primary, personal email of the candidate to be created

phoneNumberstring nullable

Primary, personal phone number of the candidate to be created

linkedInUrlstring nullable

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

githubUrlstring nullable

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

websitestring nullable

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

alternateEmailAddressesstring[] nullable

Array of alternate email addresses to add to the candidate's profile

sourceIdstring uuid nullable

The source to set on the candidate being created

creditedToUserIdstring uuid nullable

The id of the user the candidate will be credited to

createdAtstring nullable

An ISO date string to set the candidate's createdAt timestamp. When this value isn't provided, the createdAt timestamp defaults to the time the call was made.

Example request

{
  "name": "Adam Hart",
  "email": "test@ashbyhq.com",
  "phoneNumber": "555-555-5555",
  "linkedInUrl": "https://linkedin.com/in/user",
  "githubUrl": "https://github.com/user",
  "website": "https://twitter.com/user",
  "alternateEmailAddresses": [
    "test.email@ashbyhq.com"
  ],
  "sourceId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "creditedToUserId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "location": {
    "city": "San Francisco",
    "region": "California",
    "country": "United States"
  },
  "createdAt": "2022-08-12T20:29:56.964Z"
}

Response

Responses from the candidate.create endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-16T10:30:00.000Z",
    "name": "Adam Hart",
    "primaryEmailAddress": {
      "value": "adam.hart@example.com",
      "type": "Personal",
      "isPrimary": true
    },
    "emailAddresses": [
      {
        "value": "adam.hart@example.com",
        "type": "Personal",
        "isPrimary": true
      }
    ],
    "primaryPhoneNumber": null,
    "phoneNumbers": [],
    "socialLinks": [],
    "tags": [],
    "applicationIds": [
      "f9e52a51-a075-4116-a7b8-484deba69004"
    ],
    "resumeFileHandle": null,
    "fileHandles": [],
    "profileUrl": "https://app.ashbyhq.com/candidates/e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "source": null,
    "creditedToUser": null,
    "timezone": null,
    "fraudStatus": null
  }
}