API Reference

Update role

patch
https://user-api.omni.chat/v1/roles/

Updates a custom role's properties. Requires admin role.
SSM users must pass retailerId as a query parameter.

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

The ID of the role.

Query Params
string

Retailer ID (required for SSM users).

Body Params
string

New display name for the role.

string

New description for the role. Can be set to an empty string.

boolean

Whether the role is visible to users in the interface.

Responses

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?