GRgreenhouse
Candidates

Bulk create candidates

Asynchronously create many candidate profiles in a single call, typically for HRIS sync workflows that create a batch of candidates at once. Each item follows the same shape as POST /v3/candidates, with first_name and last_name required; all other profile fields are optional. Pass a nested application object to create the candidate's first application — supply a job_id to create an applicant, or a prospect_pool_id (and omit job_id) to create a prospect. A bulk_action_uuid is returned immediately. Per-item success or failure is reported through GET /v3/bulk_requests/{bulk_action_uuid}.

post/v3/candidates/bulk

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/candidates/bulk
  • Auth
    OAuth 2
    Authorization code: https://auth.greenhouse.io/authorize
    Client credentials
    Token URL: https://auth.greenhouse.io/token scopes: harvest:candidates:create

Request body

callback_urlstring

Optional HTTPS URL Greenhouse will POST to when every row in data has finished. Omit to poll GET /v3/bulk_requests/{bulk_action_uuid} instead.

Response

Accepted

bulk_action_uuidstring

UUID assigned to the new bulk request. Use this with GET /v3/bulk_requests/{bulk_action_uuid} to monitor progress and retrieve per-row results.

statusstring

Initial lifecycle state of the new bulk request, typically building immediately after creation. See the bulk request response schema for the full set of values.

status_urlstring

Relative path that returns the current status of the bulk request. Append this to your Harvest base URL to fetch the latest state.

Changes

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