Updates an equity grant for an employee

put

https://api.hibob.com/v1/people/{id}/equities/{entry_id}

This endpoint updates an entry in the employee’s equity table.

Note that the entire equities entry will be overwritten with the data provided in your payload. Any columns not included in the payload will be cleared (set to empty values).

Path Params

string

required

Employee ID

entry_id

integer

required

The entry ID to update.

Body Params

An equity grant entry as returned in reads.

int64

The ID of the equity table entry.

quantity

double

required

The number of equities granted.

equityType

string

required

The type of the grant.

vestingCommencementDate

date | null

Vesting commencement date.

consentNumber

string | null

Consent number.

grantDate

date | null

Date the equity was granted.

optionExpiration

date | null

Date the options expire.

exercisePrice

Exercise price for the grant.

vestingTerm

string | null

Terms for exercising this grant.

taxPlan

string | null

Tax plan associated with the grant.

specialTerms

string | null

Special terms associated with the grant.

grantType

string | null

Grant type. One of: Initial Grant, Merit Grant

vestingSchedule

int64 | null

The vesting schedule ID assigned to this grant.

grantNumber

double | null

The Grant number for employee.

grantStatus

string | null

Grant status. one of: Granted, Pending Approval

grantAmount

Total grant amount in currency.

change

object

Details of the last change to this entry.

Response

200

Entry updated successfully.