./candidates

post

https://api.breezy.hr/v3/company/{company_id}/position/{position_id}/candidates

Add a new candidate to a position

Path Params

company_id

string

required

position_id

string

required

Query Params

stage_actions_enabled

boolean

Defaults to false

When origin is "sourced", should stage actions be executed (defaults to false). This is always true when origin is "applied"

Body Params

name

string

required

email_address

string

*required when origin is "applied"

phone_number

string

address

string

summary

string

tags

origin

string

Defaults to sourced

( sourced | applied ) -> will indicate in Breezy if the candidate should be marked as sourced or applied

source

string

Defaults to Breezy API

custom source to attribute to the incoming candidate

work_history

array

work_history

education

array

education

social_profiles

object

custom_attributes

array

{ name: String, value: String, secure: Boolean } - secure determines if the value should be encrypted at rest

custom_attributes

cover_letter

string

Responses

Language

Credentials

Header

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

202202

400400

401401

500500