v1

latestOpenAPI 3.1.02026-07-224239180.9 KB

Application

Update an application

Updates the supplied internal note, candidate-portal state, and hiring-team assignments. Omitted fields are preserved; nullable team IDs clear their assignment, while internal_note and is_portal_enabled are write-only because the summary does not expose them. The response is re-read after the update and contains the readable application summary.

patch/v1/applications/{applicationId}

Path parameters

applicationIdstring required

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

Example:app_a1b2c3d4e5f64789a1b2c3d4e5f64789

Request body

internal_notestring

Replaces the internal note; omit to preserve. Write-only.

hiring_manager_idstring nullable

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

is_portal_enabledboolean

Replaces portal state; omit to preserve. Write-only.

recruiter_idstring nullable

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

coordinator_idstring nullable

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

sourcer_idstring nullable

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

Example request

{
  "hiring_manager_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "recruiter_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "coordinator_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "sourcer_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
}

Response

Success

idstring required

Canonical application ID (app_ followed by 32 lowercase hexadecimal UUID characters).

status'ACTIVE' | 'REJECTED' | 'HIRED' | 'CONVERTED' | 'ARCHIVED' required

last_changed_stage_atstring date-time nullable required

ISO 8601 timestamp.

created_atstring date-time required

ISO 8601 timestamp.

updated_atstring date-time required

ISO 8601 timestamp.

app_urlstring uri required

Example response

{
  "id": "app_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "candidate": {
    "id": "can_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  },
  "job": {
    "id": "job_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  },
  "current_stage": {
    "id": "stg_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  },
  "recruiter": {
    "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  },
  "coordinator": {
    "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  },
  "hiring_manager": {
    "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  },
  "sourcer": {
    "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  }
}