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

integer

ID.

reason

string

The reason for this change.

effectiveDate

date

required

The date this entry becomes effective.

quantity

double

required

The number of equities granted.

equityType

string

required

The type of the grant.

vestingCommencementDate

date

Vesting commencement date.

consentNumber

string

Consent number.

grantDate

date

Date the equity was granted.

optionExpiration

date

Date the options expire.

exercisePrice

object

vestingTerm

string

Terms for exercising this grant.

grantType

string

Grant type. One of: Initial Grant, Merit Grant

vestingSchedule

number

The vesting schedule ID assigned to this grant.

grantNumber

double

The Grant number for employee.

grantStatus

string

Grant status. one of: Granted, Pending Approval

Response

200

Entry updated successfully.

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here!