The POST request contains a candidate's data under the following structure:

Request

FieldTypeDescription
comeet_idstringUnique candidate ID
first_namestring
middle_namestring
last_namestring
emailstring
time_createdtimestampYYYY-MM-DDTHH:mm:ssZ
phonestring
mobile_phonestring
id_numberstring
linkedin_urlstring
sourceobjectData about the candidate's source, NULL if the candidate doesn't have a source
source.namestring
source.typestringOne of the following:
Agency
Campus
Comeet Elastic Recruiting
Internal
Job Board
Job fairs
Other
Referrer: Compensated
Referrer: Uncompensated
Social network
Sourcing
Web
source.comeet_idstringUnique source ID
resumeobject
resume.namestring
resume.urlstringA public URL for the candidate resume. The link will expire three minutes after being delivered.
pictureobject
picture.urlstringA public URL for the candidate profile picture. The link will expire 200 seconds after being delivered.
linksarray
links[].urlstring
files[]array
files[].namestring
files[].urlstring
files[].typestringOnly files of type "offer_letter" are supported
opening.description
opening.reason
positionobject
position.comeet_idstringUnique positions ID
position.namestringInternal position name
position.departmentstring
position.descriptionHTML
position.requirementsHTML
position.position_idstringThe position id that was set by the costumer. may also be null or empty string. Not to be confused with position.comeet_id
position.locationstring
position.employmentstring
poisiton.employee_typestringEmployee type, one of:
Outsource
Headcount
Intern
or null
position.senioritystring
position.hiring_managerobject
position.hiring_manager.first_namestring
position.hiring_manager.last_namestring
position.hiring_manager.emailstring
position.leading_recruiterobject
position.leading_recruiter.first_namestring
position.leading_recruiter.last_namestring
position.leading_recruiter.emailstring
position.custom_fieldsobjectKey-value pairs of public custom position category fields. Note that default fields (department, location, etc) are part of the position object
custom_fieldsobjectKey-value pairs of custom candidate fields
{  
  "comeet_id":"19E.98",
  "first_name":"Bobby",
  "middle_name":"Robert",
  "last_name":"Chauck",
  "email":"[email protected]",
  "time_created":"2016-08-10T13:30:02Z",
  "phone":"07-4442321",
  "mobile_phone":"052-8644246",
  "id_number":"5454-2233-1",
  "linkedin_url":"https://www.linkedin.com/in/bobby-hauck-06b0735",
  "hired_date":"2016-10-16",
  "start_date":"2016-10-23",
  "source":{  
    "name":"JobmeHR",
    "type":"Agency",
    "comeet_id":"101E.27"
  },
  "resume":{  
    "name":"bobby_cv.docx",
    "url":"https://comeet-euw-qa.s3-eu-west-1.amazonaws.com/65c0a9ff2166g"
  },
  "picture":{  
    "url":"https://comeet-euw-qa.s3-eu-west-1.amazonaws.com/e43123cff1231g0"
  },
  "links":[  
    {  
      "url":"http://www.personalportfolio.com"
    }
  ],
  "files": [
    {
      "name": "Offer letter.pdf",
      "url": "https://comeet-euw-qa.s3-eu-west-1.amazonaws.com/e4376598f1231g0",
      "type": "offer_letter"
    }
  ],
  "opening": {
       "description": "For team A",
       "reason": "new",
  },
  "position":{  
    "comeet_id":"34D.98",
    "name":"Automation QA",
    "description": "<div>QA Automation Engineer - Remote working<br><br>We are looking for a QA Automation Engineer who is excited by the opportunity to build modern, open source software for financial institutions, government regulators, and others taking on the challenges of interoperability and financial inclusion. Here, as QA Automation Engineer, you’ll get the chance to work on something truly unique, that has real, lasting impact in real-time payments, and financial inclusion of the poor.<br><br>Our mission is to improve lives by accelerating universal access to reimagined financial services. It is our belief that technology is the key to driving this access for the most vulnerable and disadvantaged people.<br><br></div>"
    "requirements": "<ul><li>Agile software development experience (Kanban, Scrum)</li><li>Experience with testing and authoring test automation for both REST and SOAP based web services</li><li>Experience working with Selenium using page object modelling</li></ul>"
    "department":"R&D",
    "position_id": "AQA_011",
    "location": "New York",
    "employment": "Full-time",
    "employee_type": "Headcount",
    "seniority": "Senior",
    "hiring_manager":{  
      "first_name":"David",
      "last_name":"Black",
      "email":"[email protected]"
    },
    "leading_recruiter":{
      "first_name":"Brandon",
      "last_name": "Liao",
      "email":"[email protected]"
    },      
    "custom_fields":{  
      "custom field":"value",
      "custom field 2":"value 2",
      ...
    }
  },
  "custom_fields":{  
    "custom field":"value",
    "custom field 2":"value 2",
    ...
  }
}

Response

Expecting HTTP 200. In case of an error, make sure to include a clear and actionable description of the problem in the response shown to the user.