Patch Offer

patch

https://apiv2.{domain}.ai/api/v2/ats/offers/{offerId}

Patches an offer given its id. Note: All required body params in the schema are not enforced in PATCH request, unlike path params.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

offerId

string

required

ID of an offer in Eightfold

Body Params

stockVestingFrequency

string | null

Stock vesting frequency

stockOptionsType

string | null

Type of stock options

offerStatus

string | null

status of the offer

candidateAddress

string | null

Candidate address

currency

string | null

Currency for compensation

jobTitle

string | null

Job title

relocationBonus

float | null

Relocation bonus amount

workplaceType

string | null

Workplace type

payGradeId

int32 | null

Pay grade of the offer

variableBonus

float | null

Variable bonus amount

note

string | null

Additional notes

customInfo

object | null

Custom info

jobLocation

string | null

Job location

bonusPayFrequency

string | null

Bonus pay frequency

joiningDate

string | null

Joining date

templateId

int32 | null

Template id of the template used to create the offer

countryCode

string | null

Country code

visaType

string | null

Visa type

candidateEmail

string | null

Candidate email address

isPeopleManagerRole

boolean | null

Whether this is a people manager role

watchers

array of strings | null

Watchers

watchers

isRehire

boolean | null

Whether this is a rehire

stockOptionsDescription

string | null

Stock options description

stockOptionsTotalVestingYears

int32 | null

Total years for stock options vesting

salaryAmount

float | null

Base salary amount

shiftAllowance

float | null

Shift allowance amount

stockOptionsAmount

int32 | null

Stock options amount

totalCompensation

float | null

Total compensation amount

basePayFrequency

string | null

Base pay frequency

candidateFullName

string | null

Candidate full name

atsData

object | null

ATS-system metadata

joiningBonus

float | null

Joining bonus amount

stockOptionsPercentageVesting

string | null

Stock options vesting percentage

stockVestingStartDate

string | null

Stock vesting start date

Headers

Authorization

string

required

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

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK