How Can We Help?
Print

Using Job Description Templates

You spent a great deal of time drafting the perfect job description. The description has been carefully edited, reviewed and approved by stakeholders in your company and there’s a good chance that you will need multiple people for this position. Instead of having this description cut and pasted multiple times, a better way to share this job description among your HR team is to create a template which can be reused and edited whenever necessary. This is where Job description templates can be useful

Creating a Job Description Template

The first step is creating a template for a job description that may be reused for future positions in your growing company. Let’s take a look at an example within Postman. For this example, we will be creating a Position of “QA Tester”with the following fields and values:

Key
Value
Description
company_id
string
This is the value associated with your company and will not change
name
string
The name of the position
description
string
A human readable description that prospective hires will read.

Creating a new Job Description Template in Postman

Let’s go back to Postman and recreate the fields in our example above:

We’ll use the POST method with the request URL: https://YOURCOMPANY.applicant-tracking.com/api/v1/jtemplates/job_descriptions
Under Headers area put in the following column values:
Key: Content-type
Value: application/json
Under Body, select the “raw” and see if you can recreate the format as in the example:
Hit “Send”

And here is the corresponding payload:

{
“id”: “1378”,
“company_id”: “15664”,
“name”: “QA Tester”,
“description”: “This is a new exciting offer See terms and conditions
}

Note that the endpoint will automatically create a field called “id” which will be used to identify this specific Job Description Template.

When you go to your site, you will find the corresponding Job Template is now available for use within your site (Account Details > Templates > Job Descriptions)

Along with the description we have entered in this example:
cURL Commands
curl -u YOUR_KEY https://YOURCOMPANY.applicant-tracking.com/api/v1/templates/job_descriptions -H “Content-Type: application/json” \
-d ‘{
“company_id”: “15664”,
“name”: “QA Tester”,
“description”: “This is a new exciting offer See terms and conditions
}’

Of course, your description will be much more detailed, but now you can add templates that will be selectable for anyone on your team with permissions to use Job Descriptions.

Getting a List of Job Description Templates in Postman

A colleague of ours came up with a new Job Description template for a position called “Sales Representative”. To return a list of all the available templates within our site let’s go back to Postman:

  • We’ll use the GET method with the request URL: https://YOURCOMPANY.applicant-tracking.com/api/v1/templates/job_descriptions
  • Under Headers area put in the following column values:
    • Key: Content-type
    • Value: application/json
  • Hit Send, and within the Body frame you will see a full payload of our “QA Tester” position along with the “Sales Representative” :

The payload will also include a field called “id” which will be used to identify this specific Job Description Template.

Getting, Updating and Deleting individual Job Description Templates

Once you have created a bunch of Job Description Templates, retrieving, updating and deleting a specific Job Description template is easy and straightforward. Simply change append the system created “id” to the request URL and change the method to either GET, PUT, or DELETE.

Table of Contents