Application API

Create a New Candidate Application

Changed on Nov 3, 2026

Operation is done on behalf of a candidate – they can access and edit the data, including attachments

post/postings/{uuid}/candidates

Request

Base URL
https://api.smartrecruiters.com
URL
https://api.smartrecruiters.com/postings/{uuid}/candidates
Auth
- OAuth 2
  Authorization code: https://www.smartrecruiters.com/identity/oauth/allow
  Client credentials
  Token URL: https://api.smartrecruiters.com/identity/oauth/token scopes: candidate_applications_manage
- or API key in header x-smarttoken

Path parameters

uuidstring required

Posting UUID

Request body

firstNamestring required

lastNamestring required

emailstring email required

conditionalsIncludedboolean

Specifies whether conditional questions should be returned in the response. 'false' if not specified

phoneNumberstring

tagsstring[]

messageToHiringManagerstring

consentboolean

consentDecisionsobject

customScopeDecisionsobject

internalboolean

Response

Successful request

idstring

createdOnstring

applicationIdstring

Changes

Nov 3, 20268e4cf290d3ff Revision changes
- breaking
  added the new required request property //
- breaking
  added the new required request property //
- breaking
  added the new required request property //
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  the request property // became required
- breaking
  the request property // became required
- breaking
  the // request property's minLength was increased from 0 to 1
- breaking
  the / request property's minLength was increased from 0 to 2
- breaking
  the / request property's minLength was increased from 0 to 1
- breaking
  the / request property's minLength was increased from 0 to 1
- breaking
  added the pattern \d{4}-\d{2}-\d{2} to the request property //
- breaking
  added the pattern \d{4}-\d{2}-\d{2} to the request property //
- breaking
  the request property format changed from no format to email
- warning
  the // request property's maxLength was set to 200
- warning
  the // request property's maxLength was set to 4000
- warning
  the // request property's maxLength was set to 200
- warning
  the // request property's maxLength was set to 200
- warning
  the // request property's maxLength was set to 200
- warning
  the / request property's maxLength was set to 128
- warning
  the / request property's maxLength was set to 128
- warning
  the / request property's maxLength was set to 128
- warning
  the / request property's maxLength was set to 6
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property //
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- warning
  removed the request property /
- info
  added the new optional request property
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  the request property / became optional
- info
  the request property / became optional
- info
  the // request property's minLength was decreased from 1 to 0
- info
  the // request property's minLength was decreased from 1 to 0
- info
  the // request property's minLength was decreased from 1 to 0
- info
  the / request property's minLength was decreased from 1 to 0
- info
  the / request property's minLength was decreased from 1 to 0
- info
  the // request property format was generalized from when to no format
- info
  the // request property format was generalized from when to no format

Operation history