Create a user

post

https://test.wonolo.com/api_v2/users

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

Body Params

user[customer_id]

number

required

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

user[role]

string

enum

required

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

Allowed:

user[user_badges_attributes][badge_id]

number

required

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

user[synced_worker_id]

number

required

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

user[last_name]

string

required

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

user[first_name]

string

required

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

user[password_confirmation]

string

required

Must be specified and match password, if specified.

user[password]

string

required

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

user[email]

string

required

User email - must be unique.

user[type]

string

enum

required

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

Allowed:

token

string

required

Token obtained from /authorize

user[gender]

string

User's gender

user[avatar_url]

string

user[address]

string

user[city]

string

user[address_state]

string

user[zip]

string

user[phone]

string

user[suspended]

boolean

True if the User is currently suspended

user[suspended_at]

string

user[rating]

number

User's current rating (out of 5.0)

user[agreed_to_terms]

boolean

True if the User has agreed to terms

user[agreed_to_terms_date]

string

user[external_id]

string

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

user[onboarding_last_state]

string

enum

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

user[w2_employee_id]

string

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

user[drug_tested]

string

enum

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

Allowed:

user[verified_phone]

string

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

user[phone_verified_at]

string

This attribute is used for Workers only.

user[user_badges_attributes][id]

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.

user[user_badges_attributes][_destroy]

string

enum

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

Allowed:

user[title]

string

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

Response

403

Forbidden - if you have Public Pool access only