Update staff

Update a staff member.

🔒

Required scope: Staff_Update (restricted — must be explicitly granted on your API key)

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

The staff member's unique identifier (GUID)

Body Params
integer
required

The unique ID of the role to assign to this staff member, that determines the user's permissions

string | null

External ID of the staff member

string
required

First name of the staff member

string
required

Last name of the staff member

string
required

Email of the staff member

string | null

Contact phone number of the staff member

string | null

An optional nickname used for display purposes in apps and the activity stream

staffIdentities
array of strings | null

List of optional staff identities to attribute to this staff member

staffIdentities
Allowed:
hqVenueGroupTags
array of strings | null

List of hqVenueGroupTags the staff member should have access to (for HQ venues only).

hqVenueGroupTags
hqVenueUniqueIds
array of uuids | null

List of hqVenueUniqueIds the staff member should have access to (for HQ venues only).

hqVenueUniqueIds
string | null

Staff members accessing POS require a PIN

Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json