API Reference
Back to Waitwhile ↗︎

Update a user

post
https://api.waitwhile.com/v2/users/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of user

Body Params
string

Identifier of location

array | string
roles
array of strings
length ≤ 10

User roles

roles
string | null
enum

User job level

notifications
object

User notification settings

reports
object
string | null
enum

Language code in two character ISO 639-1 format

string | null
enum

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

boolean

Flag to indicate if user skipped onboarding checklist

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.

addMessagingTokens
array of objects
length ≤ 20

Tokens used for sending user notifications

addMessagingTokens
removeMessagingTokens
array of objects
length ≤ 20

Tokens used for sending user notifications

removeMessagingTokens
addLocationIds
array of strings

Unique identifiers

addLocationIds
removeLocationIds
array of strings

Unique identifiers

removeLocationIds
addRoles
array of strings
length ≤ 10

User roles

addRoles
removeRoles
array of strings
length ≤ 10

User roles

removeRoles
addLabels
array of objects
length ≤ 10

Labels

addLabels
removeLabels
array of objects
length ≤ 10

Labels

removeLabels
removeAuthProviderIds
array of strings
length ≤ 10

List of auth provider IDs to remove from the user

removeAuthProviderIds
string
length between 3 and 100

Name of user

string
length ≤ 100

Email address

string | null

Phone number in E.164 format

string | null

Photo URL

string
length between 8 and 100

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

string | null

Identifier of resource

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

Updated 8 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago