HR core: profiles, onboarding, lifecycle
Invite Prop Traders
Bulk-provisions up to 100 prop traders (person, role, contractor, onboarding request) and emails invites with per-row outcomes.
Not available to API keys yet. It will need people:write.
curl --request POST \
--url 'https://api.toku.com/hris/invite-prop-traders' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"invites": [
{
"email": "user@example.com",
"givenName": "string",
"familyName": "string",
"countryCode": "string"
}
]
}'{
"results": [
{
"email": "string",
"roleInOrgID": "string",
"outcome": "INVITED",
"reason": "string",
"reasonCode": "EMAIL_MULTIPLE_ACCOUNTS"
}
]
}Authorizations
AuthorizationstringheaderrequiredBearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.
Body
application/json
invitesobject[]requiredNOTE(ck): a .refine() rule is not mirrored here; TGA still enforces it NOTE(ck): a .transform() rule is not mirrored here; TGA still enforces it
Allowed: 1 to 100 items
Show child attributes
emailstring<email>requiredgivenNamestringrequiredAllowed: 1 to 120 characters
familyNamestringrequiredAllowed: 1 to 120 characters
countryCodestringrequiredAllowed: 2 to 2 characters
Response
200Successful response
resultsobject[]requiredShow child attributes
emailstringrequiredroleInOrgIDstring | nullrequiredoutcomestringrequiredAvailable options: INVITED, RESENT, ALREADY_ONBOARDED, DUPLICATE, PROVISION_FAILED, DELIVERY_FAILED
reasonstring | nullrequiredreasonCodestring | nullrequiredAvailable options: EMAIL_MULTIPLE_ACCOUNTS, EMAIL_IN_OTHER_ORG, EMAIL_UNAVAILABLE, MULTIPLE_WORKER_SEATS, SEAT_INACTIVE, ALREADY_WORKER_IN_ORG, UNSUPPORTED_COUNTRY, EMAIL_NOT_SENT, ARCHIVED_ORG, TRANSIENT, null