Create an applicant

Operation ID: createApplicant

Group: People Management › Applicants

Open in the interactive reference

POST /people/applicants

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Creates an applicant and their first application. The request creates a person and their first application to a recruitment together. If a person with the same email already exists, the request uses that person instead of creating a new one.

The application starts in status 'new'. The response contains only the new application's id.

To apply an existing person to another recruitment, use POST people/applications.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.

Request body

Required, application/json: createApplicantInput.

Field Type Required Description
person object yes The personal details of the applicant.
person.firstName string yes The applicant's first name.
person.lastName string yes The applicant's last name.
person.email string yes The applicant's email address. If it already belongs to a person, that person is reused rather than created again.
person.middleName string no The applicant's middle name.
person.phoneNumber string no The applicant's phone number.
application object yes The application details.
application.recruitmentId string yes The identifier of the recruitment being applied to. See id on GET people/recruitments/:id.
application.source any no How the application arrived. Omit to leave it unset. One of: "appliedDirectly", "sourcedInternally", "sourcedExternally", "employeeReferral", "externalRecruiter".
application.sourceDetails string no Free-text detail about the source, for example the referring employee or the job board.
application.expectedSalary string no The applicant's salary expectation, as free text.
application.linkedIn string no The URL of the applicant's LinkedIn profile.
application.shortIntroduction string no A short free-text introduction or motivation supplied with the application.
address object no The applicant's home address. When you send it, line1, city, country and zipCode are all required.
address.line1 string yes The first address line: street number and name, or PO box.
address.line2 string no The second address line: apartment, suite, unit, building or floor.
address.city string yes The city or locality.
address.country string yes The country. Format ISO 3166-1 alpha-2, for example 'US'.
address.stateProvince string no The state or province, as the code the platform's state and province list uses, for example 'CA'. Not a spelled-out name.
address.zipCode string yes The postal or ZIP code. Required whenever you send an address. 
{
  "person": {
    "firstName": "<firstName>",
    "lastName": "<lastName>",
    "email": "<email>",
    "middleName": "<middleName>",
    "phoneNumber": "<phoneNumber>"
  },
  "application": {
    "recruitmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "source": "appliedDirectly",
    "sourceDetails": "<sourceDetails>",
    "expectedSalary": "<expectedSalary>",
    "linkedIn": "<linkedIn>",
    "shortIntroduction": "<shortIntroduction>"
  },
  "address": {
    "line1": "<line1>",
    "line2": "<line2>",
    "city": "<city>",
    "country": "<country>",
    "stateProvince": "<stateProvince>",
    "zipCode": "<zipCode>"
  }
}

Response

200 Success

Under data (createApplicantOutput):

Field Type Required Description
id string yes The unique identifier for the created application. 
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
RECRUITMENT_NOT_FOUND 400
DUPLICATE_APPLICATION 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses