GuidesAPI Reference
Log In
API Reference
These docs are for v2025.2.0. Click to read the latest docs for v2026.2.0.

Update user

patch
https://api.epicorretailcloud.com/api/organization/v1/user//

Updates a user.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The unique system assigned value that identifies this record.

Body Params

Serializer for Updating users

string
length between 1 and 30

The user's first name.

string
length between 1 and 30

The user's last name.

string
length between 1 and 30

The username.

string
length between 1 and 64

The user's display name.

string
length between 1 and 32

The user's employee number.

string
length ≤ 254

The email address.

string
length between 1 and 32

The mobile phone number.

string
length between 1 and 128

The user's password.

date-time

The password expiration date.

boolean

Determines whether password expires.

integer

The user's PIN Number.

boolean

Determines whether the password is checked at POS.

boolean

Force password change on next logon?

boolean

Is this user treated as inactive?

boolean

Is this user an administrator?

boolean

Is this user a user administrator?

boolean

Is this user an Epicor Retail Cloud core user?

integer
deprecated

The user's default branch.

integer

The user's default store.

Headers
integer
required

The id of the active store to be used for this API invocation

string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Updated over 1 year ago

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

Updated over 1 year ago

Did this page help you?