Upsert Candidate Profile

Creates or updates a candidate profile in a candidate feed.

Use this endpoint to insert or update a batch of candidate profiles in a candidate feed. An upsert operation is a combination of an insert and update: new candidate profiles are inserted, and existing candidate profiles are replaced. It is used in conjunction with Retrieve Candidate Profile and Delete Candidate Profile to manage partner-supplied candidate feeds.

Batch Processing:

Each candidate profile in a batch will be processed independently. The following steps are performed when a batch is received:

  1. The payload is confirmed to be well-formed JSON. An HTTP 422 error response is returned if the payload cannot be parsed, if the number of entries is greater than 25, or if any entries do not contain a profile-id. An HTTP 413 error response is returned if the payload size exceeds 20 MB.
  2. Basic validation is performed on entries in the batch. If all entries fail, an HTTP 422 error response is returned. Otherwise, an HTTP 202 (Accepted) response is returned, detailing the errors for profiles that failed validation.
  3. The validated candidate profiles are submitted for asynchronous, parallel processing.
  4. Webhook notifications can be configured to report a failure (due to any reason beyond basic validation) to upsert an individual candidate profile, allowing callers to address issues with the failed profile (instead of the entire batch). Webhook notifications include a result status, profile_id, a candidate_feed_id, the time of processing, and the error messages generated during processing for the failed individual candidate profile.

Additional Notes:

  • Access: To access this service and attain a candidate_feed_id, please contact your AdeptID Partner Success team.
  • Custom Filters: Candidate profile custom filters are searchable scalar fields whose meaning is customer-defined. Custom filters provide the following data types: string, integer, boolean, float, and datetime. For example, custom_filters.string_1 may store the name of the candidate’s current employer, and custom_filters.date_3 may contain the start date for the candidate’s current job.
  • Location: The candidate’s location, used during search, is a latitude/longitude centroid value derived (when possible) from the supplied postal_code, or the supplied city, state, and country if no postal_code is supplied. AdeptID will not return an error if a latitude/longitude cannot be derived from the provided location fields for a candidate; the candidate will not appear in location-specific searches.
  • Skill, Certification, and Language Inputs: Candidate profiles can contain lists of skills, certifications, and languages held by a candidate. These entities do not need to be normalized to a taxonomy before an upsert operation. Inputs to [Candidate Search], however, do need to be normalized.
Language
Credentials
Header
Click Try It! to start a request and see the response here!