API Reference

Create user

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

Creates a new user. Requires admin role.

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

Request body for creating a new user.
roles defaults to ["service"] if not provided.
configuration defaults to { stickerSendingDisabled: false, cannotStartConversation: false } if not provided.

string
required

The user's display name. Only alphanumeric characters, spaces and the characters -()._ are allowed.

string
required

The user's login username (email address). Only alphanumeric characters and -.+_@ are allowed.

string
required

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

string

URL of the user's profile picture.

string | null

The seller code associated with this user.

roles
array of strings
Defaults to service

List of roles assigned to the user. Defaults to ["service"] if omitted.

roles
teams
array of objects

Teams the user is a member of.

teams
supervisedTeams
array of objects

Teams the user supervises. Required when roles includes supervisor.

supervisedTeams
configuration
object

User configuration flags. Defaults to { stickerSendingDisabled: false, cannotStartConversation: false } if omitted.

boolean

When true, marks the user as a support agent.

boolean

When true, marks the user as a bot.

boolean

When true, marks the user as an API-only user.

boolean

Whether the user should be created in a disabled state.

groupRetailers
array of strings

Aggregated retailer IDs to grant multi-retailer group access to. Only accepted for
admin callers whose retailer is the MAIN contract of a group. When present, the
created user becomes the group principal (groupId set) and a linked user is
created in each listed retailer. Response is 201 when every retailer succeeds,
207 when any leg fails.

groupRetailers
Responses

502

Reserved. A group orchestrator failure on this route does not reach this
status. The principal is already persisted, so the response is 207 with
every requested retailer reported as failed.

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?