API Reference

Create role

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

Creates a new custom role for a retailer. 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…
Query Params
string

Retailer ID (required for SSM users; defaults to default if not provided).

Body Params
string
required

Display name for the role.

string
required

Unique identifier for the role (used as the role key).

boolean
required

Whether the role is visible to users in the interface.

string

Optional description of what the role grants.

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?