Create a job listing

This guide explains how to create a new job listing on our platform.

Prerequisites

• An existing business in Canada Motor Jobs and its ID
• Detailed information about the position to be filled

Endpoint

POST https://canadamotorjobs.com/api/v1/{locale}/job-listings/create

Parameters

Parameter	Type	Description	Default
ref_id	string, nullable	Reference identifier for the listing in your system	null
business_id	string, required	The business ID	-
confidential	boolean, optional	Whether the listing is confidential	false
department_id	string, optional	The department ID	null
section_id	string, optional	The section ID	null
job_title_id	string, optional, required if job_title_name not provided	The job title ID. It is preferable to provide the job title ID rather than the name to properly associate the listing with site sections and newsletters. You can provide a different job title (job_title_name) even if you provide the job title ID.	null
job_title_name	string, optional, required if job_title_id not provided	The desired job title name	null
experience_required	integer, nullable	Experience required for the position	null
salary_shown	boolean, optional	Whether salary is displayed	true
salary	float, optional	The listing salary; if null the default value associated with the job title will be used. It is preferable to provide the salary value yourself rather than letting the system determine the default.	35000.00
salary_method_id	string, optional	What will be displayed above the salary • 'possible': Possible salary • 'experience': Based on experience • 'collective_agreement': Per collective agreement	'possible'
salary_before_text	string, optional	Text displayed before the salary • 'upTo': Up to • 'startingAt': Starting at • 'none': ''	'upTo'
commissions	string, optional	Text displayed after the salary or instead of salary • 'none': '' • 'only': 'Commissions only' • 'plus': '+ commissions'	'none'
bonuses	string, optional	Text displayed after the salary or instead of salary • 'none': '' • 'plus': '+ bonuses'	'none'
vacations	integer, min:2, max:36, optional	Number of weeks of vacation per year	null
hiring_bonus_value	float, optional	Hiring bonus amount if available	null
hiring_bonus_timeframe	string, optional	Unit for the timeframe before receiving the hiring bonus. Can be left empty if immediate or if you do not wish to display the timeframe. • 'day': Per day • 'week': Per week • 'month': Per month • 'year': Per year	null
hiring_bonus_period	integer, optional	Number of periods for the timeframe before receiving the hiring bonus. Can be left empty if immediate or if you do not wish to display the timeframe. (e.g.: hiring_bonus_period of 12 with hiring_bonus_timeframe of 'week' means the bonus will be paid 12 weeks after hiring)	null
job_type	string, optional	The job type ID	permanent
workplace	string, optional	The workplace ID	location
custom_description	string, optional	Job listing description	null
custom_details	string, optional	More specific details related to the candidate sought	null
ai_assisted	boolean, optional	Whether you want our AI to generate or optimize your custom_description for you	false
ai_assisted_instruction	string, optional	Instructions for our AI to generate or optimize your custom_description	null
auto_translate	boolean, optional	Whether you want our AI to automatically translate your job listing into English and Spanish; if (false), you will need to add translations manually after creating the listing. You can leave it enabled and edit the texts later.	true
callback_application_url	string, nullable	Callback URL for application notifications	null

Response codes

Code	Message	Description
JOB_LISTING_CREATED	The job listing was created successfully	Returns the created job listing information
INVALID_PARAMETERS	The parameters provided are invalid	Returns the error information
NOT_AUTHORIZED	You do not have the necessary permissions	You do not have the necessary permissions to create a job listing for this business
ERROR_SERVER	The server encountered an error while creating the job listing	Returns the error information