Skip to main content
POST
Bulk Add Grants

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
roleInOrgExternalID
integer
required

External ID of the recipient

Example:

12345

grantName
string
required
Example:

"Q1 Grant"

grantConfigurationName
string
required
Example:

"Standard RTU"

grantAmount
number
required
Example:

10000

grantConfigurationID
string<uuid>
grantAmountInFiat
number
vestingStartDate
string<date-time>
vestingFrequencyType
enum<string>
Available options:
MONTHLY,
QUARTERLY,
ANNUALLY
vestingPeriods
number
vestingCliffPeriods
number
vestingCliffPercentage
number
grantDate
string<date-time>
tags
string[]
pricePerUnit
number
grantTemplateID
string

Response

Grants created