API Reference

Updates an Employee Account by ID

put
https://api-gw.appetize.services/accounts/employee-accounts/

Updates a specific employee account by internal Connect ID. Assigned Vendors and Custom fields cannot be updated as part of this endpoint

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

Connect Internal Employee Account ID

Body Params
integer

Connect-assigned unique identifier

string
length between 1 and 255

The full name of the user.

string
length ≥ 1

Value printed on the guest receipt

string

Personal Identifier employee enters to sign into non-Connect applications.

string
length between 0 and 15

External identifier for the user.

string
length between 0 and 255

External job title/description this employee holds.

boolean
Defaults to false

Indicator if the account is active or inactive. When updating an account, omitting this field is equivalent to active = false

boolean
Defaults to false

Indicator if the account has been locked.

role
object
temporary_assignment_date_range
object

Object is included if the assignment is temporary and omitted if assignment is permanent

vendor_assignments
array of objects

An array of individual Vendor Assignents for the employee account

vendor_assignments
custom_fields
array of objects
length ≥ 0
custom_fields
Responses
204

Success

Updated over 3 years ago

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

Updated over 3 years ago