Skip to main content
POST
Add Single Grant

Authorizations

Authorization
string
header
required

Personal API token. Create via createUserApiToken endpoint.

Headers

x-role-type
enum<string>
required

Role context for the request. Use CLIENT_ORG_ADMIN for most integrations.

Available options:
CLIENT_ORG_ADMIN,
PAYROLL_ADMIN,
FINANCE_ADMIN,
TOKU_ADMIN

Body

application/json
grantName
string
required
grantConfigurationID
string<uuid>
required
grantAmount
number
required
recipientID
string
required

roleInOrgID of the recipient

grantDescription
string
vestingStartDate
string<date-time>
vestingFrequencyType
enum<string>
Available options:
MONTHLY,
QUARTERLY,
ANNUALLY
vestingCliffPercentage
number
vestingCliffPeriods
number
vestingPeriods
number
lockup
number
isSection83bElectionEligible
boolean
offPlatformDate
string<date-time>
tags
string[]

Response

Grant created

grantID
string<uuid>