Create new application

post

https://api.jaicob.ai/applications/{vacancyId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

vacancyId

string

required

The ID of the vacancy (uuid)

Body Params

applicantDetails

object

required

The details of the applicant. Use the POST endpoint /file/resume to parse the resume.

status

string

The candidate status to create the candidate with. 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.

function

string

description

string

resumeUrl

string

The URL for the uploaded resume. Use the POST endpoint /file/resume to parse and upload the resume.

workExperiences

array of objects

workExperiences

educations

array of objects

educations

certifications

array of objects

certifications

appliedWith

string

The source of the application.

coverLetter

string

The cover letter of the applicant.

consentInterview

boolean

If the applicant consents with recieving a screening interview. They agree to the privacy policy https://jaicob.ai/legal/privacy and the terms and conditions https://jaicob.ai/legal/terms-conditions.

privacyConsent

boolean

Whether the applicant gave privacy/GDPR (AVG) consent for the processing of their personal data, per https://jaicob.ai/legal/privacy. When true, the server records the moment of consent. Optional for backwards compatibility with existing integrations; for non-career channels, consent collection is the integrator’s responsibility.

remarks

string

Any remarks from the applicant.

Headers

x-api-key

string

required

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

Responses

400

No email has been provided, or the status is not one of the company’s configured statuses

401

No or an invalid API key was set

404

No vacancy was found

409

Candidate has already applied

410

Vacancy has expired

422

A required answer is missing

500

Internal error

201Candidate has successfully applied