Jobs

Update job status

Changes job status via dedicated endpoint for status automation. Recommended for publish/unpublish/archive transitions.

patch/jobs/{id}/status

Request

  • Base URL: https://api.100hires.com/v2
  • URL: https://api.100hires.com/v2/jobs/{id}/status
  • Auth: HTTP bearer

Path parameters

idstring required

Job ID (numeric) or alias

Query parameters

includestring

Comma-separated list of related resources to include. Supported: workflow, hiring_team, pipeline_stages.

Request body

statusstring required

New job status (e.g. Draft, Public, Archived). See GET /taxonomy/statuses.

Response

Updated job

idinteger required

Unique identifier

aliasstring nullable

Short alphanumeric alias used in UI URLs. Use this to build job links — https://app.100hires.com/job/{alias}/candidates/pipeline. Also accepted as {id} in API requests.

company_idinteger required

ID of the company this job belongs to

titlestring required

Public job title shown to candidates

internal_titlestring nullable

Internal job title visible only to the hiring team

internal_job_idstring nullable

Company's internal job identifier (e.g. requisition number)

descriptionstring

Job description (HTML). Present only when view=full (default); omitted entirely when view=summary to keep list responses inside the agent context budget. Use GET /jobs/{id} or view=full to retrieve.

resume_field_status'required' | 'optional' | 'hidden' nullable

Whether resume upload is required, optional, or hidden on the application form

urlstring required

Public URL of the job posting page

url_backofficestring

Backoffice URL — opens the job's pipeline view inside the recruiter app (https://app.100hires.com/job/{alias}/candidates/pipeline). Use this to link agent widgets / UI to the in-app job page rather than the public career page.

is_remoteboolean required

Whether this is a remote position

is_hybridboolean required

Whether this is a hybrid position: office days plus remote days at the job address. Never true together with is_remote.

job_board_remote_scope'city' | 'statewide' | 'nationwide' nullable

How a remote job is listed on Indeed: city, statewide or nationwide. Null when the job is not remote.

statusstring required

Job status: open, closed, draft, or archived

workflow_idinteger nullable

ID of the hiring workflow (pipeline) assigned to this job

form_idinteger nullable

ID of the application form candidates fill in for this job — the form attached to the job, or the company default form when the job has none attached yet (the same rule the public apply page follows). null only when the company has no forms. Fetch the questions with GET /forms/{id}. Present in both view=full and view=summary.

salary_minnumber nullable

Minimum salary

salary_maxnumber nullable

Maximum salary

salary_currencystring nullable

Salary currency code (e.g. USD, EUR)

salary_period'annually' | 'monthly' | 'daily' | 'hourly' nullable

Salary period

hours_per_week_mininteger nullable

Minimum hours per week

hours_per_week_maxinteger nullable

Maximum hours per week

indeed_posting_dataobject

Indeed job board posting metadata. Present only when view=full (default); omitted entirely when view=summary.

is_satelliteboolean

Whether this job is a satellite (child) of a canonical job. Satellite jobs share the candidate pipeline of their parent.

parent_job_idinteger nullable

ID of the canonical (parent) job. Null for canonical jobs. Recruiting operations should target the canonical job.

languagestring nullable

Locale this job's public page renders in, overriding the career site language. Null means the page follows the career site language (GET /companies/career-site-settings), which in turn falls back to en-US. This is the override, not the effective language. Present in both view=full and view=summary.

created_atinteger required

Unix timestamp (seconds)

updated_atinteger required

Unix timestamp (seconds)

Example response

{
  "alias": "79SZHfT",
  "language": "de-DE"
}

Changes

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