Sign in
latestOpenAPI 3.0.1Proprietary2026-08-1844131294.9 KB

59cd6443fdbf

Customer Users

Create a customer user

Creates a new user account for a customer.

This endpoint provisions a user account with the specified role and associates it with the customer.

Security:

  • Requires valid partner access token (Bearer token)

Validation:

  • Email must be a valid email address
  • First name and last name are required
  • Role must be a valid CustomerUserRole enum value
post/v1/partner/customers/{customerId}/users

Path parameters

customerIdobject required

Customer ID

Request body

firstNamestring required

User's first name

lastNamestring required

User's last name

emailstring email required

User's email address

role'ADMIN' | 'BILLING_ADMIN' | 'PAYROLL_ADMIN' | 'HR_ADMIN' | 'MANAGER' required

User's role within the customer:

  • ADMIN: Administrator user to fully manage customer account
  • BILLING_ADMIN: Billing administrator user to manage customer billing
  • PAYROLL_ADMIN: Payroll administrator user to manage customer payroll
  • HR_ADMIN: HR administrator user to manage customer HR

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@acme.com",
  "role": "ADMIN"
}

Response

Customer user created successfully

idstring required

Unique customer user identifier

firstNamestring

User's first name

lastNamestring

User's last name

emailstring email required

User's email address

role'ADMIN' | 'BILLING_ADMIN' | 'PAYROLL_ADMIN' | 'HR_ADMIN' | 'MANAGER' required

User's role within the customer:

  • ADMIN: Administrator user to fully manage customer account
  • BILLING_ADMIN: Billing administrator user to manage customer billing
  • PAYROLL_ADMIN: Payroll administrator user to manage customer payroll
  • HR_ADMIN: HR administrator user to manage customer HR
customerIdstring required

Customer ID this user belongs to

Example response

{
  "id": "018e3f7a-3c4b-7a1d-9f2e-5b8c6d4a1e3f",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@acme.com",
  "role": "ADMIN",
  "customerId": "018e3f7a-2b1c-7d8e-4f5a-6c7b8d9e0f1a"
}