API Reference

Delete role

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

Deletes a custom role. Optionally reassigns users with this role to a replacementRoleId.
Requires admin role.

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

ID of the role that will replace this role for users currently assigned to it.
If not provided, users may lose access to role-specific features.

teams
array of objects

Teams to be updated as part of the role deletion.

teams
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?