Skip to main content

Job Offer Requirements

What's a Job Offer Requirement?​

It's any relevant information that must be shared by an applicant in order to fill out and submit an application for a particular job offer. This can be in the form of text, a file, or a simple boolean. Examples include a CV to be uploaded, a cover letter in a text area, or information about years of experience. It is not to be confused with aptitudes or skills required for the job position (for example, proficiency in Scala or relevant work experience with Excel).

Despite being defined at the Job Offer level, it is actually relevant to the application process itself.

Requirement Field Types​

Every job offer requirement has a specific field type. This defines the expected input type (usually handled by the UI through which applications are created). The current supported types are:

  1. Text
  2. Number
  3. Email
  4. Phone
  5. Boolean
  6. File
  7. File List
  8. Text Area

Mandatory vs. Optional Requirements​

This simply defines whether the requirement information must be included in an application or if it can be left out.

Requirements at Workspace Level vs. Job Offer Level​

There are two sources for requirements within a job offer: the Workspace level and the Job Offer level. Both work the same way, and the only difference lies in where they are sourced from:

  1. Workspace Level: As the name suggests, these are requirements defined at the workspace level and will be added to all job offers created under that workspace. Currently, this must be the workspace that directly owns the employer, and they must be configured directly through the database. They are useful for recurring job offer requirements. For example, an organization could require all job offer applications to include first and last names. Defining this specific requirement every time a job offer is created can be cumbersome, so defining it once at the workspace level and having it automatically assigned allows for a much more expedited process. Since they are maintained directly through the database, there is no way to edit or remove them via any API endpoint. Additionally, any changes made through the database will only be reflected in the published channels once a sync is triggered. Attempting to modify them through the update job offer endpoint will result in an error.

  2. Job Offer Level: These are requirements defined only for the specific job offer in question and won't affect any other job offers. They work well for more specific types of requirements, such as a PDF version of a particular certificate needed for a Cyber Security Analyst position. These may be edited or removed when updating a job offer, and all changes to published job offers will be immediately reflected in their corresponding publishing channels.

Ultimately, the combination of both Workspace-level and Job Offer-level requirements makes up the entire list of requirements for a job offer.

Creating Job Offer Level Requirements​

Job Offer level requirements can be created either through the create job offer endpoint or the update job offer endpoint:

  1. POST Create Job Offer All requirements included here will be considered new Job Offer level requirements and will therefore be added to the job offer.

  2. PUT Update Job Offer All requirements included here that do not have an id will be considered new Job Offer level requirements and will therefore be added to the job offer.

Editing Job Offer Level Requirements​

To edit Job Offer level requirements, simply use the update job offer endpoint:

PUT Update Job Offer

Requirements must include their corresponding id in order to be updated correctly.

Removing Job Offer Level Requirements​

To remove Job Offer level requirements, simply use the update job offer endpoint:

PUT Update Job Offer

All Job Offer level requirements that are currently part of the job offer but are excluded from the update request body will be removed.

Publishing Job Offer Requirements​

Calling the Publish Job Offer method will also include the current job offer requirements:

POST Publish Job Offers

If a job offer is already published and its requirements are updated, these updates will automatically be forwarded to the relevant publishing channels so the changes are reflected.

Common Errors​

  1. Incorrect or non-existent ID: The requirement won't be found in the job offer and will be completely omitted from the operation.
  2. Job offer requirement not configurable: By default, all Job Offer level requirements are configurable, while Workspace level ones are not. If there is an attempt to modify any field of a non-configurable requirement, an error will be thrown.