Skip to main content
PATCH
Update a job stage

Authorizations

Authorization
string
header
required

API tokens are passed as Bearer tokens.

Path Parameters

jobStageId
string
required

a job stage 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: ^(?:stg_)?(?:[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:

"stg_a1b2c3d4e5f64789a1b2c3d4e5f64789"

Body

application/json
settings
object
required

Job-stage settings patch. Include at least one settings group.

Response

Success

id
string
required

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

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

"stg_a1b2c3d4e5f64789a1b2c3d4e5f64789"

job_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
index
integer
required
schedulable
boolean
required
ats
object | null
required
has_custom_interview_plan
boolean
required
settings
object
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.