Create a user

post

https://api.waitwhile.com/v2/users

Body Params

userId

string

Identifier of user

name

string

length between 3 and 100

Name of user

string

length ≤ 100

Email address

phone

string | null

Phone number in E.164 format

photoUrl

string | null

Photo URL

defaultLocationId

string

Identifier of location

locationIds

array of strings

Location identifiers

locationIds

roles

array of strings

length ≤ 10

User roles

roles

jobLevel

string

enum

User job level

password

string

length between 8 and 100

Password of user, at least 8 characters, one uppercase, one lowercase, one number

notifications

object

User notification settings

reports

object

language

string | null

enum

Language code in two character ISO 639-1 format

locale

string | null

enum

Locale in xx-YY format, where the first part is language and second country code

skipOnboarding

boolean

Flag to indicate if user skipped onboarding checklist

externalId

string | null

External identifier, optionally provided by client

metadata

object | null

Store metadata about your objects. You can store 20 keys with max length 40. Values can be strings of max length 500.

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created