HIhibob
Applicants

Create an applicant

Submits a hired candidate into Bob as a pending hire. The record is added to ATS Pending Hires; an employee is created only after HR activates the New Hire flow. Only fields that are part of that New Hire flow are populated on the employee. One applicant per request.

A 201 response does not guarantee all documents were uploaded. Always inspect warnings. When every document downloads successfully (or the request carries none), the body is { "id": ... } with no warnings key. When one or more documents fail to download, warnings lists each failed file; the applicant is still stored.

OAuth scopes (app-user): applicants:write

Rate limit: 10 requests per minute per authenticated company.

post/external-hires/applicants

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/external-hires/applicants
  • Auth
    HTTP bearer

Request body

fieldsobject required

Flat map of Bob employee field id to value. Keys come from GET /v1/company/people/fields (for example root.firstName). The supported value shape depends on the field type: JSON scalars (string, number, boolean) or nested objects for complex types (for example payroll.salary.payment: { "value": 85000, "currency": "GBP" }). Dates use YYYY-MM-DD strings. See <a href="https://apidocs.hibob.com/docs/fields-metadata#field-types">Field types</a> for the full catalog.

Required: root.firstName (string), root.surname (string).

Recommended: root.email (string), work.startDate (YYYY-MM-DD), work.title (string), work.department (string), work.siteId (site name string, for example "London", not a numeric id).

Computed fields (for example work.durationOfEmployment) are ignored and logged. Unresolved complex values are dropped and logged; the request still succeeds when the required fields are present.

Response

Success

idinteger required

Identifier of the stored pending hire, sent as a JSON number (not a quoted string).

Changes

No recorded changes to this operation across all 1 revision of this API.