Create user

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Path Params

location

string

required

The uuid or url_name the location in which to create the user

Body Params

The payment method

firstName

string

The first name of the user

lastName

string

The last name of the user

acl

string

The access control list for the user

displayName

string

A desired display name for the user, normally used in interfaces. If not supplied will default to firstName + lastName

phoneNumber

string

The phone number of the user. If not supplied the user will be created as a restricted user with limited permission

posPin

string

The POS pin for the user. The length of the pin should match the length configured for the location

payRate

number

The pay rate of the user in the smallest unit of the currency of the location. Used as the default pay rate of any supplied user roles. Has no effect if userRoles is not supplied

userRoles

array of objects

The user roles for the user. Must match an existing role at the location

userRoles

sendSms

boolean

Whether to send a SMS to the created user. Defaults to false

string

The email address of the user

aclAgentConfig

object

Agent-specific configuration to store on the user's acl (e.g. clockin_enforced, or an external system's user id). Fully replaces any existing value for this location's acl row — it does not merge, so a partial write clears the keys it omits. Read the current value from GET /users and merge client-side to preserve keys you do not own. Omit the field to leave the stored config untouched; pass {} to clear it.

metadata

object

Arbitrary additional metadata to store on the user (e.g. an external system's user id). Shallow-merged with existing metadata.