Applications

Add a candidate to a job

Add an existing candidate to an existing job in your CVViZ account.

POST

/applications

curl --request POST \
  --url https://api.cvviz.com/v1/applications \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: cvviz-integration-operation-001' \
  --header 'Content-Type: application/json' \
  --data '
{
  "candidateId": 501,
  "jobId": 901
}
'

{
  "data": {
    "candidateId": 501,
    "created": true,
    "id": "901:501",
    "jobId": 901
  }
}

This creates the candidate's application for that job. It does not create a candidate profile or automatically run candidate screening.

The returned application ID uses jobId:candidateId, for example 901:501. If the association already exists, created is false.

Permissions

applications.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>.

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

candidateIdintegerrequired

Required range: 1 <= x

Example: 501

jobIdintegerrequired

Required range: 1 <= x

Example: 901

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