v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB

Offer

Patch Offer by ATS IDs

Upserts an offer identified by ATS IDs (system + ats candidate id + ats position id). If an offer already exists for the resolved (candidate, position) it is patched in place; otherwise a new offer is created and linked to the candidate's latest application. PATCH semantics: idempotent; only fields present in the body are applied; absent fields are not touched.

patch/api/v2/ats/offers/ats-systems/{systemId}/ats-candidates/{atsCandidateId}/ats-positions/{atsPositionId}

Path parameters

systemIdstring required

ATS system id (e.g. 'successfactors')

atsCandidateIdstring required

ATS-side candidate id (e.g. SF candidateId)

atsPositionIdstring required

ATS-side position / job requisition id (e.g. SF jobReqId)

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Request body

createdAtinteger nullable

Timestamp of when the offer was created

stockVestingFrequencystring nullable

Stock vesting frequency

versionsstring[] nullable

All versions of the offer

stockOptionsTypestring nullable

Type of stock options

offerStatusstring nullable

status of the offer

profileIdstring nullable

unique identifier for profile

candidateAddressstring nullable

Candidate address

currencystring nullable

Currency for compensation

versionstring nullable

Version of the offer

groupIdstring nullable

group id

jobTitlestring nullable

Job title

relocationBonusnumber float nullable

Relocation bonus amount

workplaceType'remote_global' | 'remote_local' | 'hybrid' | 'onsite' nullable

Workplace type. Possible values: ['remote_global', 'remote_local', 'hybrid', 'onsite']

payGradeIdinteger nullable

Pay grade of the offer

variableBonusnumber float nullable

Variable bonus amount

notestring nullable

Additional notes

customInfoobject nullable

Custom info

jobLocationstring nullable

Job location

bonusPayFrequencystring nullable

Bonus pay frequency

offerIdinteger nullable

Offer id

templateIdinteger nullable

Template id of the template used to create the offer

countryCodestring nullable

Country code

offerLetterobject nullable

Offer letter details

visaTypestring nullable

Visa type

candidateEmailstring nullable

Candidate email address

isPeopleManagerRoleboolean nullable

Whether this is a people manager role

watchersstring[] nullable

Watchers (email list)

joiningTsinteger nullable

Joining timestamp in seconds since epoch

isRehireboolean nullable

Whether this is a rehire

stockOptionsDescriptionstring nullable

Stock options description

stockOptionsTotalVestingYearsinteger nullable

Total years for stock options vesting

stockVestingStartTsinteger nullable

Stock vesting start timestamp in seconds since epoch

updatedAtinteger nullable

Timestamp of when the offer was last updated

salaryAmountnumber float nullable

Base salary amount

shiftAllowancenumber float nullable

Shift allowance amount

stockOptionsAmountnumber float nullable

Stock options amount

totalCompensationnumber float nullable

Total compensation amount

createdBystring nullable

User email who created the offer

basePayFrequencystring nullable

Base pay frequency

candidateFullNamestring nullable

Candidate full name

joiningBonusnumber float nullable

Joining bonus amount

stockOptionsPercentageVestinginteger[] nullable

Stock options vesting percentages per period (list of ints)

positionIdinteger nullable

job id

applicationIdinteger nullable

application id

Response