API Reference

Update user

put
https://user-api.omni.chat/v1/users/

Updates a user by its id.

Users with the admin role may update any user and send the full request body supported by the schema.

Users without the admin role may only update themselves (userId in the path must match the authenticated user).
In that case, only name, avatar, and id from the body are applied; other fields are ignored.
Attempting to update another user returns 403 Forbidden.

Self-edit does not change roles, password, teams, or other restricted fields.

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

The ID of an existing user.

Query Params
boolean

When true, team associations (member and supervisor) are not updated on Parse.
Non-admin users updating their own profile always behave as if this were true.

Body Params

Request body for updating a user.

Admin users may update any user and use any field below.

Non-admin users may only update their own profile and only name, and avatar are applied; all other fields are silently ignored.

string

User ID. Commonly included in self-edit requests.

string

New display name for the user.

string | null

New profile picture URL.

string

New login username (email address).

string

New password. Must contain eight or more characters with a combination of
letters (upper and lower case), numbers and symbols.

string | null

The seller code associated with this user.

string | null

The area or department the user belongs to.

roles
array of strings

List of roles to assign to the user.

roles
Allowed:
teams
array of objects

Teams the user is a member of. Required when roles is exactly ["service"].

teams
supervisedTeams
array of objects

Teams the user supervises. Required when roles includes supervisor.

supervisedTeams
configuration
object

Partial configuration update. Only provided fields are updated.

groupRetailers
array of strings

Complete desired set of aggregated retailer IDs for the multi-retailer group.
Only accepted for admin callers whose retailer is the MAIN contract of a group;
the MAIN retailer itself cannot appear in this list. Retailers missing from a
previous call are revoked (linked user disabled, sessions destroyed). Ignored
for a groupUser=true target — group linked users cannot have their own
groupRetailers.

groupRetailers
Responses

502

Multi-retailer group orchestrator unavailable.

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?