Skip to main content
PATCH
Update person compensation

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Path Parameters

id
string
required

Person UUID

compensation_id
string
required

Compensation UUID

Body

application/json
job_id
string<uuid> | null

Associated job UUID, if this compensation is specific to a job candidacy.

current_compensation_base
number | null

Base salary amount.

Required range: x >= 0
current_compensation_bonus
number | null

Bonus amount.

Required range: x >= 0
compensation_type
enum<string> | null

Type of compensation: desired for expectations, actual for current or historical compensation, or minimum for a required floor.

Available options:
desired,
actual,
minimum
currency_code
string | null

ISO 4217 currency code (e.g. "USD", "EUR"). Defaults to USD when omitted.

Required string length: 3
equity_percent
number | null

Equity grant as a percentage.

Required range: 0 <= x <= 100
equity_amount
number | null

Equity grant as a fixed amount.

Required range: x >= 0
compensation_year
integer | null

The year this compensation applies to (e.g. 2025 for historical compensation).

Required range: 1900 <= x <= 3000
total_estimated_compensation
number | null

Total estimated annual compensation.

Required range: x >= 0
note
string | null

Free-text notes about the compensation package, constraints, or preferences.

Response

Compensation updated

success
enum<boolean>
required
Available options:
true
data
object
required