Create a job
This endpoint allows you to create a new job record.
In the required parameters, you have to call this endpoint with AT LEAST ONE of the following attributes:
office_id
office_address
office_zip_code
office_city
(mandatory for creation)office_country_code
(mandatory for creation)
If the related office is not found from the previous parameters, we will try to create the office if the following conditions are respected:
access to
offices_rw
scopeall mandatory attributes to create an office:
office_city
andoffice_country_code
create job
POST
https://www.welcomekit.co/api/v1/external/jobs
Query Parameters
organization_reference*
string
Reference of the associated organization/company
profession_reference (deprecated)
string
Reference of the associated profession (This information is not used on our side anymore.)
name*
string
Job name. Max length 200 characters
company_description
string
Company description (Describe the company).
description*
string
Job description (Explain the job, not the company). Max length 10 000 characters
profile*
string
Job profile (Explain who you’re looking for)
recruitment_process
string
Job Recruitment Process (Delay / Interviews / Tests / etc.)
contract_type*
string
Contract type for this job. Has to be a value from our dependencies list
language*
string
Language for this job
status
string
Job status
salary_min
integer
Minimum salary for a given salary_period
salary_max
integer
Maximum salary for a given salary_period
salary_currency
string
Currency for the given salary
salary_period
string
Period for the given salary
is_remote
boolean
[DEPRECATED] Is remote work authorized for this job?
remote
string
Is remote work authorized for this job?
contract_duration_min
integer
Recommended for 'TEMPORARY’ contract type
contract_duration_max
integer
Maximum duration of the contract in months. Max value 36 (months)
department_id
integer
Department ID. Mainly used by companies which have a careers website managed through WelcomeKit.co
offices: id
integer
Office ID. An office is like a “location”. You can use the List Offices
API to retrieve the list of office ids. Also, if you don’t have anid
you can call the API with offices: zip_code
or offices: country_code
which may be enough for us to retrieve the associated office (if any) or dynamically create a new one.
offices: address
string
Office address (office will be found or created from this).
See: comment related to offices : id
offices: zip_code
string
Office zip code (office will be found or created from this).
See: comment related to offices: id
offices: city
string
Office city (office will be found or created from this).
See: comment related to offices: id
offices: country_code
string
Office country code (office will be found or created from this).
See: comment related to offices: id
education_level
string
Minimum education level ID
experience_level
string
Minimum experience level ID
apply_url
string
Job application URL. Do not input anything if you want to use WelcomeKit as your ATS
start_date
string
Start date for this job (YYYY-MM-DD)
external_reference
string
External provider Reference / ID for this job. (unique constraint)
cms_sites_references
string
Comma separated list of cms sites references to publish this job
offices
array
List of office objects. Office attributes are listed below.
{
"name" : "Fake Job",
"external_reference" : "PROVIDER_REFERENCE1",
"organization_reference" : "Pg4eV6k",
"status" : "published",
"profile" : "Fake Job Profile",
"apply_url" : "http://company.com/jobs/superjob/apply/",
"company_description" : "Fake Company Description.",
"contract_duration_min" : null,
"experience_level" : "1_TO_2_YEARS",
"department_id" : null,
"profession_reference" : "sales",
"cms_sites_references" : "wttj_fr,smgo_fr",
"contract_duration_max" : null,
"start_date" : "2016-09-01T00:00:00.000+02:00",
"description" : "Fake Job Description.",
"contract_type" : "FULL_TIME",
"language": "en",
"salary": {
"min": "30000",
"max": "40000",
"currency": "EUR",
"period": "yearly"
},
"remote" : "fulltime",
"office_id" : 196,
"reference" : "WTTJ_gld0A7L",
"education_level" : "BAC_5",
"created_at" : "2017-11-13T17:15:26.146+01:00",
"updated_at" : "2017-11-13T17:15:26.146+01:00",
"published_at" : "2017-11-13T18:00:01.146+01:00",
"archived_at" : null
}
Request example
curl -X POST "https://www.welcomekit.co/api/v1/external/jobs" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer WK_API_KEY" \
-d @- <<EOF
{
"status": "published",
"organization_reference": "Pg4eV6k",
"profession_reference": "sales",
"name": "Fake Job",
"company_description": "Fake Company Description.",
"description": "Fake Job Description.",
"profile": "Fake Job Profile",
"contract_type": "FULL_TIME",
"language": "en",
"salary_min": "30000",
"salary_max": "40000",
"salary_currency": "EUR",
"salary_period": "yearly",
"remote": "fulltime",
"offices": [
{"id": 1234},
{"city": "Paris", "country_code": "fr"}
],
"education_level": "BAC_5",
"experience_level": "1_TO_2_YEARS",
"apply_url": "http://company.com/jobs/superjob/apply/",
"start_date": "2016-09-01",
"external_reference": "PROVIDER_REFERENCE",
"cms_sites_references": "wttj_fr,smgo_fr"
}
EOF
Last updated
Was this helpful?