Updates an Identity

Updates an Identity entity.

Each field has its own validation rules. Below are some notable behaviors to be aware of:

  • managementType — Automatically determined based on the primary email domain and the organization's registered domains. Even if managed is specified, the actual value may be recategorized (e.g. external, system) depending on the email domain.
  • employeeType — Must be compatible with the resolved managementType. If an incompatible type is provided, a default will be assigned.
  • primaryEmail / secondaryEmails — Swapping values between primary and secondary emails will reorder them. If the current primary email is linked to a SaaS account, the old primary must be preserved in secondaryEmails.
  • employeeId — Must be unique within the organization.
Note: Additional system-level validations exist beyond those listed above. Refer to the error responses for details.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
number
required
string
required
Body Params
string
enum
required

Extended status of the employee

Allowed:
string
enum
required

Type of the employee

string | null
enum

Management type of the employee

Allowed:
string | null

Display name of the employee

string | null
required

First name of the employee

string | null
required

Last name of the employee

string | null

Primary email of the employee

secondaryEmails
array of strings | null

Secondary emails of the employee

secondaryEmails
string | null

Company name of the employee

string | null

Work location of the employee

department
object | null

Department of the employee

string | null

Job title of the employee

string | null

Employee ID of the employee

lifecycle
object

Lifecycle of the employee

string | null

Notes of the employee

customFields
object

Custom fields of the employee

manager
object

Manager of the employee

Responses

404

The identity is not found.

418

The feature isn't available for the organization. Please contact the support team.

422

The custom fields are invalid.

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