Skip to main content
POST
Create User Role in Org

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
email
string<email>
required
givenName
string
required
familyName
string
required
externalEmployeeID
string
payrollEmployeeID
string
country
string
employmentType
enum<string>

TGA employment type.

Available options:
CONTRACTOR,
EMPLOYEE,
EX_EMPLOYEE,
ADVISOR,
SERVICE_PROVIDER,
OTHER
sendEmailImmediately
boolean
taxMethod
string
withholdingPercentage
number
baseSalary
number
baseSalaryCurrency
string

Response

User role created

roleInOrgID
string<uuid>
Example:

"660e8400-e29b-41d4-a716-446655440001"

orgID
string<uuid>
Example:

"aa0e8400-e29b-41d4-a716-446655440005"

personID
string<uuid>
Example:

"bb0e8400-e29b-41d4-a716-446655440006"

role
string
Example:

"RECIPIENT"

externalEmployeeID
string | null
Example:

"EMP-001"

payrollEmployeeID
string | null
Example:

"PAY-12345"

country
string | null
Example:

"US"

employmentType
enum<string> | null

TGA employment type. Valid values: CONTRACTOR, EMPLOYEE, EX_EMPLOYEE, ADVISOR, SERVICE_PROVIDER, OTHER.

Available options:
CONTRACTOR,
EMPLOYEE,
EX_EMPLOYEE,
ADVISOR,
SERVICE_PROVIDER,
OTHER
Example:

"EMPLOYEE"

revokedAt
string<date-time> | null
Example:

null