Changelog
Back to All

Candidates API - Expose Application Property Key

July 14th, 2025

Description

Extending Candidates API by starting accepting the key of the application property as an id path parameter (and within the request body) of the following endpoints:

  • PUT candidates/{id}/jobs/{jobId}/properties
  • PUT candidates/{id}/properties/{propertyId}
  • PUT candidates/{id}/jobs/{jobId}/properties/{propertyId}

Extending Candidates API by adding the application property key to the response of the following endpoints:

  • GET candidates/{id}/properties
  • GET candidates/{id}/jobs/{jobId}/properties

Impact

This enhancement is backward-compatible and does not require any changes to existing client implementations. The feature brings new flexibility - the client can use the key of the application property instead of the id to access and manage the application properties data.

References