PUT/PATCH /api_v2/users/:id
Update a user
Supported Formats
jsonErrors
Code | Description |
---|---|
403 | Forbidden - if you have Public Pool access only |
Params
Param name | Description |
---|---|
token
required |
Token obtained from /authorize Validations:
|
user
required |
Validations:
|
user[id]
required |
Unique ID of the User Validations:
|
user[type]
required |
The type of User - Worker = Wonoloer, Employer = Requestor Validations:
|
user[gender]
optional |
User’s gender Validations:
|
user[email]
required |
User email - must be unique. Validations:
|
user[password]
required |
Password. Minimum 8 characters. Must be specified on creation. Validations:
|
user[password_confirmation]
required |
Must be specified and match password, if specified. Validations:
|
user[first_name]
required |
User first name - should contain only letters, numbers, dash (-) and period (.) character Validations:
|
user[last_name]
required |
User last name - should contain only letters, numbers, dash (-) and period (.) character Validations:
|
user[avatar_url]
optional |
Validations:
|
user[address]
optional |
Validations:
|
user[city]
optional |
Validations:
|
user[address_state]
optional |
Validations:
|
user[zip]
optional |
Validations:
|
user[phone]
optional |
Validations:
|
user[suspended]
optional |
True if the User is currently suspended Validations:
|
user[suspended_at]
optional |
Validations:
|
user[rating]
optional |
User’s current rating (out of 5.0) Validations:
|
user[agreed_to_terms]
optional |
True if the User has agreed to terms Validations:
|
user[agreed_to_terms_date]
optional |
Validations:
|
user[external_id]
optional |
An arbitrary value to be associated with this Worker. This attribute is used for Workers only. Validations:
|
user[onboarding_last_state]
optional |
Worker’s last onboarding state. This attribute is used for Workers only. Validations:
|
user[w2_employee_id]
optional |
Worker’s unique employee ID for W2 classified jobs. This attribute is used for Workers only. Validations:
|
user[drug_tested]
optional |
Worker’s drug test results. This attribute is used for Workers only. Validations:
|
user[verified_phone]
optional |
Worker’s verified phone. This attribute is used for Workers only. Validations:
|
user[phone_verified_at]
optional |
This attribute is used for Workers only. Validations:
|
user[user_badges_attributes]
optional |
Badges that the Worker has. This attribute is used for Workers only. Validations:
|
user[user_badges_attributes][badge_id]
required |
The ID of the Badge. This attribute is used for Workers only. Validations:
|
user[user_badges_attributes][id]
optional |
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. Validations:
|
user[user_badges_attributes][_destroy]
optional |
Set to remove this User-Badge association on updating a Worker (PATCH). This attribute is used for Workers only. Validations:
|
user[title]
optional |
Employer’s title. This attribute is used for Employers only. Validations:
|
user[role]
required |
Employer’s role. This attribute is used for Employers only. Validations:
|
user[customer_id]
required |
Employer’s customer ID. This attribute is used for Employers only. Validations:
|