Create a new candidate and assign to a job

Create a new candidate and assign to a job.

Tracking candidate source

When adding a new candidate, it's very important you track its source appropriately. In order to associate a source with your app / integration, add the below object to a candidate body object for this endpoint:

{
  "sourceDetails": {
    "sourceTypeId": "string",
    "sourceSubTypeId": "string",
    "sourceId": "string"
  }
}

sourceTypeId - it's a Source Type - available values can be found using get /configuration/sources endpoint

sourceSubTypeId - it's a Source Subtype, an optional parameter - available values can be found using get /configuration/sources endpoint

sourceId - it's a Source Id - available values for a given sourceTypeId can be found using get /configuration/sources/:sourceTypeId/values endpoint

NOTE: Not defining the source will default to API source.

NOTE II: In case you can't find an appropriate source to track against you can:

Log in to see full request history
Path Params
string
required

job identifier

Body Params

Candidate object that needs to be created.

string
required
length ≥ 1
string
required
length ≥ 1
string
required
string
location
object
web
object
tags
array of strings
tags
education
array of objects
Defaults to
education
experience
array of objects
Defaults to
experience
sourceDetails
object
boolean
Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json