candidates

Create a new candidate and assign to a Talent Pool

Create a new candidate and assign to a Talent Pool.

Tracking candidate source

When adding a new candidate, it's very important you track its source appropriately. In order to associate a source with your app/integration, add below object to a candidate body object for this endpoint:

{
  "sourceDetails": {
    "sourceTypeId": "string",
    "sourceSubTypeId": "string",
    "sourceId": "string"
  }
}

sourceTypeId - it's a Source Type - available values can be found using get /configuration/sources endpoint

sourceSubTypeId - it's a Source Subtype, an optional parameter - available values can be found using get /configuration/sources endpoint

sourceId - it's a Source Id - available values for a given sourceTypeId can be found using get /configuration/sources/:sourceTypeId/values endpoint

NOTE: Not defining the source will default to API source.

NOTE II: In case you can't find an appropriate source to track against you can:

  • Create a custom source for each customer account separately on this admin page (you need to be logged in as an admin to the customer account in order to view this page)
  • Request to partners@smartrecruiters.com adding a standard source that will be available for all customers if your app/integration is productised (available to all SmartRecruiters customers)
post/candidates

Request

  • Base URL
    https://api.smartrecruiters.com
  • URL
    https://api.smartrecruiters.com/candidates
  • Auth
    • API key in header x-smarttoken
    • or OAuth 2
      Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
      Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: candidates_create

Request body

firstNamestring required
lastNamestring required
emailstring email required
phoneNumberstring
tagsstring[]
internalboolean

Response

Created candidate.

idstring
internalboolean
firstNamestring
lastNamestring
emailstring
phoneNumberstring
createdOnstring date-time
updatedOnstring date-time
tagsstring[]
averageRatingnumber

Changes

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