Create a user

Use invite workers instead to initiate user creation after which user properties may be updated.

Body Params
number
required

Employer's customer ID. This attribute is used for
Employers only.

string
enum
required

Employer's role. This attribute is used for Employers
only.

Allowed:
number
required

The ID of the Badge. This attribute is used for Workers
only.

number
required

Worker's ID on an external server, used for syncing
purposes. This attribute is used for Workers only.

string
required

User last name - should contain only letters, numbers,
dash (-) and period (.) character

string
required

User first name - should contain only letters, numbers,
dash (-) and period (.) character

string
required

Must be specified and match password, if specified.

string
required

Password. Minimum 8 characters. Must be specified on
creation.

string
required

User email - must be unique.

string
enum
required

The type of User - Worker = Wonoloer, Employer = Requestor

Allowed:
string
required

Token obtained from /authorize

string

User's gender

string
string
string
string
string
string
boolean

True if the User is currently suspended

string
number

User's current rating (out of 5.0)

boolean

True if the User has agreed to terms

string
string

An arbitrary value to be associated with this Worker.
This attribute is used for Workers only.

string
enum

Worker's last onboarding state. This attribute is used
for Workers only.

string

Worker's unique employee ID for W2 classified jobs.
This attribute is used for Workers only.

string
enum

Worker's drug test results. This attribute is used
for Workers only.

Allowed:
string

Worker's verified phone. This attribute is used for
Workers only.

string

This attribute is used for Workers only.

number

The ID of the current User-Badge association between
this Worker and a badge - required for the '_destroy' function
below. This attribute is used for Workers only.

string
enum

Set to remove this User-Badge association on updating
a Worker (PATCH). This attribute is used for Workers only.

Allowed:
string

Employer's title. This attribute is used for Employers
only.

Response
403

Forbidden - if you have Public Pool access only

Language
Response
Click Try It! to start a request and see the response here!