Update a job

This endpoint allows you to update a job record.

This endpoint requires jobs_rw scope.

update job

PUT https://www.welcomekit.co/api/v1/external/jobs/:reference

Path Parameters

Name	Type	Description
reference*	string	Job reference

Query Parameters

Name	Type	Description
profession_reference (deprecated)	string	Reference for a given profession (This information is not used on our side anymore.)
name	string	Job name
company_description	string	Company description (Describe the company)
description	string	Job description (Explain the job, not the company)
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
language	string	Language for this job
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	Minimum duration of the contract in months.
contract_duration_max	integer	Maximum duration of the contract in months.
department_id	integer	Department ID. Mainly used by companies which have a careers website managed through WelcomeKit.co
office_id	integer	Office ID. An office is like a “location”. If the office wasn’t created for the targeted company, you will need to contact [email protected] first. Also, if you don’t have an office_id you can call the API with office_zip_code or office_country_code which may be enough for us to retrieve the associated office.
office_zip_code	string	Office zip code (office will be found or created from this). See: comment related to office_id
office_city	string	Office zip code (office will be found or created from this). See: comment related to office_id
office_country_code	string	Office country code (office will be found or created from this). See: comment related to office_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

200 Success

{
  "name" : "Fake Job",
  "external_reference" : "PROVIDER_REFERENCE1",
  "organization_reference" : "Pg4eV6k",
  "status" : "draft",
  "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" : "punctual",
  "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" : null,
  "archived_at" : null
}

Request example

curl -X PUT "https://www.welcomekit.co/api/v1/external/jobs/WTTJ_ZyDmzZ6" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer WK_API_KEY" \
    -d @- <<EOF
{
  "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": "punctual",
  "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