Skip to main content
POST
Terminate Grants (Bulk)

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
externalEmployeeID
string
required
terminationDate
string<date-time>
required
grantIDs
string<uuid>[]
required
Minimum array length: 1

Response

Grants terminated

terminatedGrantIDs
string<uuid>[]
skippedGrantIDs
string<uuid>[]
failedGrantIDs
object[]