Sign in

v1

latestOpenAPI 3.0.02026-07-14800227.2 KB
Recruiting

Create a new candidate

This endpoint will create a new candidate. You can include custom fields in the creation of the candidate, too.

post/recruiting/candidates

Request body

firstNamestring
lastNamestring
emailstring
phonestring
sourceFieldstring

Example request

{
  "firstName": "Maria",
  "lastName": "Müller",
  "email": "maria.muller@test.com",
  "sourceField": "Website integration"
}

Response

CREATED

_idstring

The _id of the candidate just created.

firstNamestring

The name of the candidate created.

lastNamestring

The last name of the candidate created.

phonestring

The phone of the candidate created.

sourceFieldstring

The source field of the candidate.

originstring

The source of the entry (e.g., API, manual, agency, browserExtension).

_createdByIdstring

The unique identifier of the creator of the record.

_updatedByIdstring

The unique identifier of the updater of the record.

_createdAtstring date-time

The creation date of the record in ISO 8601 format.

_updatedAtstring date-time

The last update date of the record in ISO 8601 format.

Example response

{
  "_id": "6751ebdf7d91779514cebbcd",
  "firstName": "Maria",
  "lastName": "Müller",
  "sourceField": "Website integration",
  "origin": "api",
  "_createdById": "67223a2a77fb00d3fb70cbac",
  "_updatedById": "67223a2a77fb00d3fb70cbac",
  "_createdAt": "2024-11-29T10:02:41.345Z",
  "_updatedAt": "2024-11-29T10:02:41.345Z"
}