Skip to main content
PATCH
Update a job

Authorizations

Authorization
string
header
required

API tokens are passed as Bearer tokens.

Path Parameters

jobId
string
required

a job ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:job_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
Example:

"job_a1b2c3d4e5f64789a1b2c3d4e5f64789"

Body

application/json
fallback_name
string | null

Candidate-facing fallback job name, shown when no job posting name is linked to the candidate's application (candidate portal, sourcing links, and job-name tokens). Set to null to fall back to the internal job name.

Minimum string length: 1
internal_note
string | null

Free-form internal note about the job; never shown to candidates.

Response

Success

id
string
required

Canonical job ID (job_ followed by 32 lowercase hexadecimal UUID characters).

Pattern: ^job_[0-9a-f]{32}$
Example:

"job_a1b2c3d4e5f64789a1b2c3d4e5f64789"

name
string
required
status
enum<string>
required
Available options:
DRAFT,
OPEN,
CLOSED
confidential
boolean
required
locations
string[]
required
hiring_team
object[]
required
ats
object | null
required
created_at
string<date-time>
required

ISO 8601 timestamp. Responses are normalized to UTC with a Z suffix.

updated_at
string<date-time>
required

ISO 8601 timestamp. Responses are normalized to UTC with a Z suffix.

app_url
string<uri>
required

Link that opens this resource in the ModernLoop app.