Update User

patch

https://api-ext.zluri.com/v2/user/{user_id}

This endpoint allows you to update specific fields of a User. You can modify user information including name, email, status, account type, designation, department, archive status, personal email, reporting manager, primary source integration details, optimization inclusion settings, and custom fields.

Supported Fields Table:

Field	Type	Description / Allowed Values
`user_name`	string	User's display name
`user_email`	string	User's primary email address (must be a valid email)
`user_personal_email`	string	Personal email address (must be a valid email)
`user_department_id`	string	Department ID (must be a valid ObjectId)
`user_status`	enum	User status (`active`, `inactive`, `suspended`, `unknown`)
`reporting_manager_id`	string	Reporting manager user ID (must be a valid ObjectId)
`user_designation`	string	Job title/designation
`user_account_type`	enum	Account type (`group`, `service`, `employee`, `external`)
`user_archive`	boolean	Archive status
`optimization_inclusion`	enum	Optimization inclusion (`include for all optimizations`, `exclude for all optimizations`, `exclude for undeprovisioned`, `exclude for unused`)
`primary_source`	object	Primary source integration details (see below)
`primary_source.keyword`	string	Integration keyword (required if primary_source is provided)
`primary_source.org_integration_id`	string	Organization integration ID (must be a valid ObjectId)
`primary_source.integration_id`	string	Integration ID (must be a valid ObjectId)
`user_custom_fields`	array	Array of custom field objects (`field_id`, `field_value`)

Notes:

All fields are optional; only include fields you want to update.
Email fields must be valid emails.
IDs must be valid ObjectIds.
user_status supports: active, inactive, suspended, unknown.
user_account_type supports: group, service, employee, external.
optimization_inclusion supports: include for all optimizations, exclude for all optimizations, exclude for undeprovisioned, exclude for unused.
primary_source fields are required together if provided.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

user_id

string

required

The unique identifier of the user to update.

Body Params

User update request body. All fields are optional - only include fields you want to update.

user_name

string

The display name of the user

user_email

string

The primary email address of the user

user_status

string

enum

The current status of the user account

Allowed:

user_account_type

string

enum

The type of user account

Allowed:

user_designation

string

The job title or designation of the user

user_department_id

string

The unique identifier of the department the user belongs to

user_archive

boolean

Whether the user account is archived

user_personal_email

string

The personal email address of the user

primary_source

object

Primary source integration details for the user

optimization_inclusion

string

enum

Specifies which optimization types to exclude the user from. Use this field to remove user from these optimization processes:

exclude for undeprovisioned: Exclude from undeprovisioned user optimization
exclude for unused: Exclude from unused user optimization
exclude for all optimizations: Exclude from all optimization types
include for all optimizations: Include in all optimization types (no exclusions)

Allowed:

user_custom_fields

array of objects

Array of custom fields and their values for the user

user_custom_fields

Headers

api-key

string

required

Your Zluri API key for authentication

Responses

200User updated successfully

400Bad request - Invalid input data

401Unauthorized - Invalid or missing API key

404User not found

409Conflict - User data conflicts with existing data

500Internal server error