/company/{id}/position/{id}/candidates

Creates a candidate on the specified position and returns the created candidate record.

  • origin: sourced (the default) adds the candidate directly into the position's "Applied" stage, as if manually sourced. origin: applied instead runs the candidate through the same path as a public application: email_address is then required, the position must be published (otherwise 412), and if the position's application form has required fields not satisfied by the payload the API returns 202 and emails the candidate a link to complete them before the record is finalized (rather than 200 with the full candidate).
  • Returns 409 if a candidate already exists on this position.
  • stage_actions_enabled controls whether add-triggered stage actions fire for sourced candidates; they always fire when origin is applied.
  • source, work_history, education, tags, social_profiles, and custom_attributes are validated and normalized (e.g. social profile keys must be from an allowed list, custom_attributes entries require name/value, and secure custom attributes get an _enc-suffixed id).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Query Params
boolean
Defaults to false

When origin is sourced, whether to execute stage actions on add. Always true when origin is applied.

Body Params
string
required
string

Required when origin is applied

string
string
string
string
tags
array of strings
tags
string
enum
Defaults to sourced
Allowed:
string

Custom source label (e.g. LinkedIn)

work_history
array of objects
work_history
education
array of objects
education
social_profiles
object

Valid keys: facebook, linkedin, twitter, dribbble, instagram, github, behance, angellist, flickr, youtube, skype, globe

custom_attributes
array of objects
custom_attributes
Responses

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