Add New User

This endpoint allows you to add a new user to your organization.

Fields Table:

FieldRequiredTypeDescription / Allowed Values
user_nameYesstringUser's full name
user_emailYesstringUser's primary email address (must be unique)
user_designationNostringUser's job title/designation
user_statusNoenumUser status (active, inactive, suspended)
user_department_idNostringDepartment ID where the user belongs
account_typeNoenumType of user account (employee, external, service, group)
reporting_manager_emailNostringEmail address of the user's reporting manager
user_personal_emailNostringUser's personal email address
user_custom_fieldsNoarrayArray of custom field values (see example below)
onboardingDataNoobjectOnboarding assignment details (see example below)

Custom Fields Format Example:

[
  {
    "field_id": "679b613f315ee0a11cb67bd0",
    "field_value": "New York"
  }
]

Onboarding Data Format Example:

{
  "assigned_to": "679b5a0a315ee0a11cb4e79b",
  "date": "2025-08-26",
  "time": "12:00 AM",
  "timezone_id": "64184b3bec8af4b1d7caa05f"
}

Notes:

  • Email addresses must be unique within the organization.
  • Department ID must exist in the organization.
  • Reporting manager email must be a valid user email in the organization.
  • Custom field IDs must be valid and accessible to your organization.
  • All validations will be applied during user creation.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The full name of the user

string
required

The primary email address of the user (must be unique)

string

The job title or designation of the user

string

The unique identifier of the department where the user belongs

string
enum

The status of the user

Allowed:
string
enum
Defaults to employee

The type of user account

Allowed:
string

The email address of the user's reporting manager

string

The personal email address of the user

user_custom_fields
array of objects

Array of custom field values for the user

user_custom_fields
onboardingData
object

Onboarding assignment details

Headers
string
required

Your Zluri API key for authentication

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json