Jobs

Update a job

Update the supported fields of an existing job.

PATCH

/jobs/{jobId}

Update a job

curl --request PATCH \
  --url https://api.cvviz.com/v1/jobs/{jobId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: cvviz-integration-operation-001' \
  --header 'Content-Type: application/json' \
  --data '
{
  "maximumExperience": 5,
  "minimumExperience": 2,
  "publishToFreeJobBoards": false,
  "title": "Senior Backend Engineer"
}
'

{
  "data": {
    "id": 901,
    "isDeleted": false,
    "isDraft": false,
    "status": 5
  }
}

What can change?

Send only the fields you want to change, using the request schema below.
Provide at least one supported field. Experience is measured in years.
If both bounds are supplied, minimum experience and minimum salary must not exceed their respective maximums.
Use PATCH /jobs/{jobId}/status for lifecycle changes.
publishToCareerPage: omit to preserve career-page publication, or send false to disable it.
publishToFreeJobBoards: defaults to false on every update. Omitting it turns off free-job-board publication, even when updating unrelated job details. Send true on each update that should keep distribution enabled.
Enabling either channel requires an active, approved job (409 otherwise). Publication does not activate or approve a job.
Free-board distribution remains subject to account, integration, moderation and provider eligibility; some channels also require career-page publication. Listing/removal is not immediate or guaranteed.
Individual boards, paid advertising, workflow, approval and recruiter-assignment settings cannot be changed here.

Permissions

jobs.write

Safe retries

Send an Idempotency-Key. Retry the same request with the same key to avoid repeating the write. See Safe retries & idempotency.

Authorizations

Authorizationstringheaderrequired

Use Authorization: Bearer <api-credential>.

Path Parameters

jobIdnumberrequired

CVViZ job identifier.

Example: 901

Headers

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

citystring

Maximum string length: 255

codestring

Maximum string length: 255

Example: ENG-104

countrystring

Maximum string length: 255

departmentIdinteger

Required range: 1 <= x

Example: 12

descriptionstring

Maximum string length: 65535

Example: Role description

hiringManagerIdinteger

Required range: 1 <= x

Example: 22

isRemoteboolean

Example: true

jobTypestring

Maximum string length: 128

Example: Full Time

maximumExperienceinteger

Maximum job experience in years.

Required range: 0 <= x

Example: 5

maximumSalarynumber

Required range: 0 <= x

Example: 160000

minimumExperienceinteger

Minimum job experience in years.

Required range: 0 <= x

Example: 2

minimumSalarynumber

Required range: 0 <= x

Example: 100000

publishToCareerPageboolean

Request career-page publication. Defaults to false on creation; omitted on update leaves this channel unchanged. Enabling requires an active, approved job.

publishToFreeJobBoardsbooleandefault:false

Request distribution to eligible free job boards managed by CVViZ. Defaults to false on both creation and update: omission on update disables free-job-board publication. Enabling requires an active, approved job. Account, integration, moderation and provider eligibility still apply; no paid advertising or guaranteed listing.

qualificationsstring

Maximum string length: 1000

Example: B.Tech

salaryCurrencystring

Maximum string length: 8

Example: USD

salaryIntervalstring

Recommended interval codes: H hourly, D daily, W weekly, M monthly, Y yearly.

Maximum string length: 32

Example: Y

statestring

Maximum string length: 255

titlestring

Maximum string length: 255

Example: Senior Backend Engineer

Response

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

Show child attributes

Still need help? Ask the team