Job Roles

Update Job Role

Update job role

Validates that job role belongs to current user's organization Requires: admin or recruiter role

put/api/job-roles/{job_role_id}

Request

  • Base URL: https://api.thebetterhire.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.thebetterhire.ai/api/job-roles/{job_role_id}
  • Auth: HTTP bearer

Path parameters

job_role_idstring uuid required

Request body

titlestring nullable
departmentstring nullable
descriptionstring nullable
location_typestring nullable
locationstring nullable
employment_typestring nullable
experience_levelstring nullable
jd_textstring nullable
job_description_urlstring nullable
statusstring nullable
use_manual_competenciesboolean nullable
quality_scoreinteger nullable
hiring_company_displaystring nullable
hiring_company_pronouncestring nullable
hiring_company_visibilitystring nullable
min_years_experienceinteger nullable
max_years_experienceinteger nullable
tagstring nullable
default_framework_codestring nullable

Response

Successful Response

idstring required
organization_idstring required
titlestring required
departmentstring nullable required
descriptionstring nullable required
location_typestring nullable required
locationstring nullable required
employment_typestring nullable required
experience_levelstring nullable required
min_years_experienceinteger nullable
max_years_experienceinteger nullable
jd_file_urlstring nullable required
jd_file_namestring nullable required
jd_textstring nullable required
job_description_urlstring nullable required
competencies_configobject required
use_manual_competenciesboolean required
statusstring required
created_bystring nullable required
created_atstring date-time required
updated_atstring date-time nullable required
interview_countinteger nullable
candidate_countinteger nullable
quality_scoreinteger nullable
hiring_company_displaystring nullable
hiring_company_pronouncestring nullable
hiring_company_visibilitystring nullable
assessment_planobject nullable
tagstring nullable
default_framework_codestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.