The candidate status. Must be one of the statuses configured for the company — use the GET endpoint /candidates/statuses to list them. Matching ignores casing and spacing. Defaults to AVAILABLE when omitted.

The URL for the uploaded resume. Use the POST endpoint /file/resume to parse and upload the resume. The file is fetched and attached to the candidate as a document, and the URL itself is stored on the candidate. A URL that cannot be reached is skipped and logged; it never fails the request. The resume is not parsed by this endpoint, so keep sending the candidate’s details in this same body.

API key generated in the app. Write permissions are required.