Update User

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:

FieldTypeDescription / Allowed Values
user_namestringUser's display name
user_emailstringUser's primary email address (must be a valid email)
user_personal_emailstringPersonal email address (must be a valid email)
user_department_idstringDepartment ID (must be a valid ObjectId)
user_statusenumUser status (active, inactive, suspended, unknown)
reporting_manager_idstringReporting manager user ID (must be a valid ObjectId)
user_designationstringJob title/designation
user_account_typeenumAccount type (group, service, employee, external)
user_archivebooleanArchive status
optimization_inclusionenumOptimization inclusion (include for all optimizations, exclude for all optimizations, exclude for undeprovisioned, exclude for unused)
primary_sourceobjectPrimary source integration details (see below)
primary_source.keywordstringIntegration keyword (required if primary_source is provided)
primary_source.org_integration_idstringOrganization integration ID (must be a valid ObjectId)
primary_source.integration_idstringIntegration ID (must be a valid ObjectId)
user_custom_fieldsarrayArray 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.
Language
Credentials
Header
Click Try It! to start a request and see the response here!