v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

EMPLOYEES

Update an employee

Updates information for a single employee. Accepts optional expand query params.

post/v3/merchants/{mId}/employees/{empId}

mIdstring required

Merchant Id

empIdstring required

Employee Id

expandstring

Expandable fields: [shifts, payments, orders, roles]

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

idstring

Unique identifier

namestring required

Full name of the employee

nicknamestring

Nickname of the employee (shows up on receipts)

customIdstring

Custom ID of the employee

emailstring

Email of the employee (optional)

inviteSentboolean

Returns true if this employee was sent an invite to activate their account

claimedTimeinteger

Timestamp of when this employee claimed their account

deletedTimeinteger

Timestamp of when this employee was deleted

pinstring

Employee PIN (hashed)

unhashedPinstring

Employee PIN

role'OWNER' | 'ADMIN' | 'MANAGER' | 'EMPLOYEE'

Employee System Role

isOwnerboolean

Returns true if this employee is the owner account for this merchant