Skip to main content
PATCH
Update job offer

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Resource UUID.

Body

application/json
job_id
string<uuid>

Move the offer to this job. The candidate must belong to the job (the current candidate, or candidate_id when that is also sent). Existing client contacts must already be on the new job unless client_contact_ids is also sent.

candidate_id
string<uuid>

Point the offer at this candidate. Must belong to the offer job (the current job, or job_id when that is also sent).

job_offer_status_id
string<uuid> | null

Offer status UUID from GET /v1/job-offers/statuses. Pass null to clear.

extended_date
string | null

When the offer was extended (ISO 8601 date or timestamp). Must not be after accepted_date or candidate_start_date.

accepted_date
string | null

When the candidate accepted (ISO 8601 date or timestamp). Must not be before extended_date or after candidate_start_date.

candidate_start_date
string | null

Anticipated start date (ISO 8601 date or timestamp). Must not be before extended_date or accepted_date.

compensation_currency
string | null

ISO 4217 currency code. Defaults to USD on create when omitted.

compensation_base
number | null

Base salary offered.

compensation_bonus
number | null

Bonus offered: a cash amount or a percentage of base, per bonus_type.

bonus_type
enum<string> | null

Whether compensation_bonus is a fixed amount or a percent of base.

Available options:
fixed,
percent
annual_equity_grant_percent
number | null

Annual equity grant, as a percent.

annual_equity_grant_amount
number | null

Annual equity grant amount.

initial_equity_grant_percent
number | null

Initial equity grant, as a percent.

initial_equity_grant_amount
number | null

Initial equity grant amount.

relocation_bonus
number | null

Relocation bonus amount.

sign_on_bonus
number | null

One-time sign-on bonus amount.

total_estimated_compensation
number | null

Total estimated compensation.

note
string | null

Offer notes. Pass null to clear.

owner_ids
string<uuid>[]

Replaces all team members credited on the offer. Pass [] to clear. Omitted leaves the current owners unchanged.

client_contact_ids
string<uuid>[]

Replaces all client contacts on the offer. Each contact must already be on the job. Pass [] to clear. Omitted leaves the current contacts unchanged.

Response

Job offer updated

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