Sign in

v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Candidate API:Candidates

Add a candidate

post/candidates

Headers

X-Allow-Duplicatesstring

Duplicate override code from the header of an earlier 409 response

Request body

firstNamestring nullable
lastNamestring nullable
emailstring nullable
phonestring nullable
mobilestring nullable
salutationstring nullable

Salutation/honorific/title

statusIdinteger nullable

Candidate status

ratingstring nullable
sourcestring nullable

Candidate source

seeking'Yes' | 'Maybe' | 'No' string
unsubscribedboolean
summarystring nullable
dateOfBirthstring date nullable
emergencyContactstring nullable
emergencyPhonestring nullable
socialobject nullable
skillTagsstring[] nullable
recruiterUserIdinteger[] nullable
customSkillsstring[] nullable

A maximum of 500 custom skills can be submitted per request

Example request

{
  "social": {
    "facebook": "https://www.facebook.com/JobAdder",
    "twitter": "https://twitter.com/jobadder",
    "linkedin": "https://www.linkedin.com/company/866656/",
    "youtube": "https://www.youtube.com/c/jobadder",
    "other": "https://jobadder.com/company/"
  },
  "custom": [
    {
      "fieldId": 1,
      "value": "Text value"
    },
    {
      "fieldId": 2,
      "value": [
        "List value 1",
        "List value 2"
      ]
    },
    {
      "fieldId": 3,
      "value": "2018-07-01"
    }
  ]
}

Response

Created

candidateIdinteger required

Candidate Id

firstNamestring nullable

First name

lastNamestring nullable

Last name

emailstring nullable

Primary email address

phonestring nullable

Contact phone number

mobilestring nullable

Mobile/cell number

mobileNormalizedstring nullable

Mobile/cell normalized number

contactMethodstring nullable

Preferred contact method

salutationstring nullable

Salutation/honorific/title

unsubscribedboolean
ratingstring nullable

Internal rating of the candidate

sourcestring nullable

The source of the candidate

seeking'Yes' | 'Maybe' | 'No' string
dateOfBirthstring date nullable

Candidate date of birth available (ISO full-date)

emergencyContactstring nullable

The emergency contact of the candidate

emergencyPhonestring nullable

The emergency phone of the candidate

otherEmailstring[] nullable

Other email addresses used by the candidate

socialobject nullable

Candidate social profiles

summarystring nullable
skillTagsstring[] nullable
createdAtstring date-time nullable
updatedAtstring date-time nullable

Example response

{
  "social": {
    "facebook": "https://www.facebook.com/JobAdder",
    "twitter": "https://twitter.com/jobadder",
    "linkedin": "https://www.linkedin.com/company/866656/",
    "youtube": "https://www.youtube.com/c/jobadder",
    "other": "https://jobadder.com/company/"
  },
  "custom": [
    {
      "fieldId": 1,
      "name": "Text Field 1",
      "type": "Text",
      "value": "Text value"
    },
    {
      "fieldId": 2,
      "name": "List Field 2",
      "type": "List",
      "value": [
        "Value 1",
        "Value 2"
      ]
    },
    {
      "fieldId": 3,
      "name": "Date Field 3",
      "type": "Date",
      "value": "2018-07-01"
    }
  ]
}