Create a candidate

This endpoint allows you create new candidates for a given job_reference.

For example, you could create a Chrome Extension which makes it easy for recruiters to create new candidates… :)

Also, if you don’t want to give full access to all your candidates to external services, you may use the my_candidates_rw scope which will let them create candidates and only access to the candidates they created.

This endpoint requires candidates_rw or my_candidates_rw scope.

candidate creation

POST https://www.welcomekit.co/api/v1/external/candidates

Query Parameters

Name	Type	Description
organization_reference*	string	Organization reference
job_reference*	string	Job reference
job_stage_id*	string	Job stage id
email*	string	Email
firstname*	string	First name
lastname*	string	Last name
tag_list	string	Comma separated list of tags
subtitle	string	Subtitle
phone	string	Phone number
remote_image_url	string	Avatar url
remote_resume_url	string	Resume url (file type: PDF, DOC, DOCX, ODT maximum file size: 5MB)
remote_portfolio_url	string	Portfolio url (file type: PDF, maximum file size: 10MB)
comment	string	A comment about this candidate
archived	boolean	Archive user
media_website	string	Candidate website url
media_github	string	Profile url on Github
media_stackoverflow	string	Profile url on Stackoverflow
media_dribbble	string	Profile url on Dribbble
media_behance	string	Profile url on Behance
media_linkedin	string	Profile url on Linkedin
media_facebook	string	Profile url on Facebook
media_instagram	string	Profile url on Instagram
media_medium	string	Profile url on Medium
media_tumblr	string	Profile url Tumblr
media_vimeo	string	Profile url on Vimeo
media_twitter	string	Profile url on Twitter
cover_letter	string	Cover letter
referrer	string	Referrer

200 Success

{
  "reference": "wttj-d655345409a6097309156b05",
  "cover_letter": "",
  "created_at": "2016-08-23T12:55:27.206+02:00",
  "job_reference": "WTTJ_KmqkD1Y",
  "modal_path": "/dashboard/o/Pg4eV6k/jobs/WTTJ_KmqkD1Y/card/wttj-d655345409a6097309156b05",
  "portfolio_size": 4242,
  "portfolio_url": "http://cdn.com/porfolio.pdf",
  "resume_content_type": "application/pdf",
  "resume_size": 4242,
  "resume_url": "http://cdn.com/resume.pdf",
  "stage_id": 14600,
  "updated_at": "2016-08-23T12:55:27.206+02:00",
  "profile": {
    "address": null,
    "avatar_url": "http://wk.dev/assets/default-avatar-7cbb7b9749a7cf8864001cde13e2a9a94e612bf083430d66ede0966f5bafb296.png",
    "city": null,
    "country_code": null,
    "country_name": null,
    "email": "[email protected]",
    "firstname": "Foo",
    "lastname": "Bar",
    "phone": null,
    "subtitle": null,
    "zip_code": null
  },
  "origin": "external",
  "archived": false
}

Request example

curl -X POST "https://www.welcomekit.co/api/v1/external/candidates" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer WK_API_KEY" \
    -d @- <<EOF
{
  "email": "[email protected]",
  "firstname": "Foo",
  "lastname": "Bar",
  "organization_reference": "Pg4eV6k",
  "job_reference": "WTTJ_KmqkD1Y",
  "remote_resume_url": "http://example.com/resume.pdf",
  "remote_portfolio_url": "http://example.com/portfolio.pdf"
}
EOF