Skip to main content
PATCH
Update an application
Beta: this endpoint may change or be removed without notice while in beta. There is no compatibility promise until it reaches general availability.

Authorizations

Authorization
string
header
required

API tokens are passed as Bearer tokens.

Path Parameters

applicationId
string
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.

Pattern: ^(?:app_)?(?:[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:

"app_a1b2c3d4e5f64789a1b2c3d4e5f64789"

Body

application/json
internal_note
string

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

hiring_manager_id
string | null

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.

Pattern: ^(?:emp_)?(?:[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:

"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"

is_portal_enabled
boolean

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

recruiter_id
string | null

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.

Pattern: ^(?:emp_)?(?:[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:

"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"

coordinator_id
string | null

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.

Pattern: ^(?:emp_)?(?:[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:

"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"

sourcer_id
string | null

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.

Pattern: ^(?:emp_)?(?:[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:

"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"

Response

Success

id
string
required

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

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

"app_a1b2c3d4e5f64789a1b2c3d4e5f64789"

candidate
object
required
job
object
required
current_stage
object | null
required
status
enum<string>
required
Available options:
ACTIVE,
REJECTED,
HIRED,
CONVERTED,
ARCHIVED
recruiter
object | null
required
coordinator
object | null
required
hiring_manager
object | null
required
sourcer
object | null
required
last_changed_stage_at
string<date-time> | null
required

ISO 8601 timestamp.

ats
object | null
required
created_at
string<date-time>
required

ISO 8601 timestamp.

updated_at
string<date-time>
required

ISO 8601 timestamp.

app_url
string<uri>
required