Skip to main content
PATCH
/
v1
/
persons
/
{id}
/
compensations
/
{compensation_id}
Update person compensation
curl --request PATCH \
  --url https://api.stardex.ai/v1/persons/{id}/compensations/{compensation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "current_compensation_base": 1,
  "current_compensation_bonus": 1,
  "currency_code": "<string>",
  "equity_percent": 50,
  "equity_amount": 1,
  "compensation_year": 2450,
  "total_estimated_compensation": 1,
  "note": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "678e9012-e34d-56f7-a890-123456789012",
    "compensation_type": "desired",
    "currency_code": "USD",
    "current_compensation_base": 200000,
    "current_compensation_bonus": null,
    "equity_percent": null,
    "equity_amount": null,
    "compensation_year": 2026,
    "total_estimated_compensation": 200000,
    "note": "Target base salary discussed with the candidate.",
    "job_id": null,
    "job_name": null,
    "created_at": "2026-05-27T21:30:00Z",
    "updated_at": "2026-05-27T21:30:00Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.stardex.com/llms.txt

Use this file to discover all available pages before exploring further.

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