API End Points

Patch Offer by ATS IDs

patch
https://apiv2.{domain}.ai/api/v2/ats/offers/ats-systems//ats-candidates//ats-positions/

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

string
required

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

string
required

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

Body Params
string | null

Stock vesting frequency

string | null

Type of stock options

string | null

status of the offer

string | null

Candidate address

string | null

Currency for compensation

string | null

Job title

float | null

Relocation bonus amount

string | null
enum

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

Allowed:
int32 | null

Pay grade of the offer

float | null

Variable bonus amount

string | null

Additional notes

customInfo
object | null

Custom info

string | null

Job location

string | null

Bonus pay frequency

int32 | null

Template id of the template used to create the offer

string | null

Country code

string | null

Visa type

string | null

Candidate email address

boolean | null

Whether this is a people manager role

watchers
array of strings | null

Watchers (email list)

watchers
int32 | null

Joining timestamp in seconds since epoch

boolean | null

Whether this is a rehire

string | null

Stock options description

int32 | null

Total years for stock options vesting

int32 | null

Stock vesting start timestamp in seconds since epoch

float | null

Base salary amount

float | null

Shift allowance amount

float | null

Stock options amount

float | null

Total compensation amount

string | null

Base pay frequency

string | null

Candidate full name

atsData
object | null

ATS-system metadata

float | null

Joining bonus amount

stockOptionsPercentageVesting
array of int32s | null

Stock options vesting percentages per period (list of ints)

stockOptionsPercentageVesting
Headers
string
required

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

Response

Updated 2 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago