Update a user

patch

https://test.wonolo.com/api_v2/users/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

number

required

Query Params

token

string

required

Token obtained from /authorize

Body Params

customer_id

number

required

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

role

string

enum

required

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

Allowed:

user_badges_attributes[badge_id]

number

required

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

synced_worker_id

number

required

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

last_name

string

required

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

first_name

string

required

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

password_confirmation

string

required

Must be specified and match password, if specified.

password

string

required

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

string

required

User email - must be unique.

type

string

enum

required

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

Allowed:

number

required

Unique ID of the User

gender

string

User's gender

avatar_url

string

address

string

city

string

address_state

string

zip

string

phone

string

suspended

boolean

True if the User is currently suspended

suspended_at

string

rating

number

User's current rating (out of 5.0)

agreed_to_terms

boolean

True if the User has agreed to terms

agreed_to_terms_date

string

external_id

string

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

onboarding_last_state

string

enum

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

w2_employee_id

string

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

drug_tested

string

enum

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

Allowed:

verified_phone

string

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

phone_verified_at

string

This attribute is used for Workers only.

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_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:

title

string

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

Response

403

Forbidden - if you have Public Pool access only