Skip to main content
Jobs

Update job status

Change an existing job to a supported lifecycle state. This does not change publication settings.

PATCH
/jobs/{jobId}/status

Permissions

jobs.status.write and an Idempotency-Key are required.

Supported states

CodeState
1Draft
2New
4Rejected
5In Progress (active)

Codes 2 and 4 do not mean Closed or On Hold. Use job options to discover supported values.

Before activating

  • Complete the required job details and skills. Complete older incomplete drafts in CVViZ first.
  • Complete any required job approval in CVViZ.
  • Ensure active-job capacity is available.

Activation clears the draft flag; other status changes preserve it. This endpoint does not approve a job or publish it to job boards.

See Create a job for the full workflow.

Common errors

  • 400: invalid state or incomplete job details.
  • 409: approval, capacity or idempotency conflict.
Authorizationstringheaderrequired

Use Authorization: Bearer <api-credential>.

jobIdnumberrequired

CVViZ job identifier.

Example: 901
Idempotency-Keystringheaderrequired

Unique key for this write: 8-128 letters, digits, periods, underscores, colons or hyphens. Reusing the same key with the same request replays its original result; different content returns 409.

Required string length: 8 - 128
Pattern: ^[A-Za-z0-9._:-]{8,128}$
Example: cvviz-integration-operation-001

Body

application/json
remarksstring
Maximum string length: 1000
statusenum<integer>required

1 Draft, 2 New, 4 Rejected, 5 In Progress (active). See GET /job-options. Separate from approval and publication.

Available options: 1, 2, 4, 5
Example: 5

Response

application/json

Mutation applied or safely replayed.

X-API-Daily-Limitintegerheader

Daily account request allowance, when metered. Shared across API credentials.

Required range: 0 <= x
X-API-Daily-Remainingintegerheader

Requests remaining in the daily window after admission.

Required range: 0 <= x
X-API-Daily-Resetstringheader

Daily window reset time in UTC.

X-API-Monthly-Limitintegerheader

Monthly account request allowance, when metered. Shared across API credentials.

Required range: 0 <= x
X-API-Monthly-Remainingintegerheader

Requests remaining in the monthly window after admission.

Required range: 0 <= x
X-API-Monthly-Resetstringheader

Monthly window reset time in UTC.

X-Request-IDstringheader

Request correlation identifier.

X-API-Contractstringheader

Response envelope contract version.

Example: canonical-v1
RateLimit-Limitintegerheader
Example: 600
RateLimit-Remainingintegerheader
Example: 598
RateLimit-Resetintegerheader
Example: 30
dataobjectrequired