PUT/PATCH /api_v2/users/:id
Update a user

Formatos soportados

json

Errores

Code Description
403 Forbidden - if you have Public Pool access only

Parámetros

Nombre del parámetro Descripción
token
requerido

Token obtained from /authorize

Validations:

  • Must be a String
user
requerido

Validations:

  • Must be a Hash
user[id]
requerido

Unique ID of the User

Validations:

  • Must be a Integer
user[type]
requerido

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

Validations:

  • Must be one of: Worker, Employer.
user[gender]
opcional

User’s gender

Validations:

  • Must be a String
user[email]
requerido

User email - must be unique.

Validations:

  • Must be a String
user[password]
requerido

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

Validations:

  • Must be a String
user[password_confirmation]
requerido

Must be specified and match password, if specified.

Validations:

  • Must be a String
user[first_name]
requerido

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

Validations:

  • Must be a String
user[last_name]
requerido

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

Validations:

  • Must be a String
user[avatar_url]
opcional

Validations:

  • Must be a String
user[address]
opcional

Validations:

  • Must be a String
user[city]
opcional

Validations:

  • Must be a String
user[address_state]
opcional

Validations:

  • Must be a String
user[zip]
opcional

Validations:

  • Must be a String
user[phone]
opcional

Validations:

  • Must be a String
user[suspended]
opcional

True if the User is currently suspended

Validations:

  • Must be one of: true, false, 1, 0.
user[suspended_at]
opcional

Validations:

  • Must be a DateTime
user[rating]
opcional

User’s current rating (out of 5.0)

Validations:

  • Must be a Float
user[agreed_to_terms]
opcional

True if the User has agreed to terms

Validations:

  • Must be one of: true, false, 1, 0.
user[agreed_to_terms_date]
opcional

Validations:

  • Must be a DateTime
user[external_id]
opcional

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

Validations:

  • Must be a String
user[onboarding_last_state]
opcional

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

Validations:

  • Must be one of: not_started, started, take_quiz, take_background_check, schedule_call, call, pending_background_check, complete, rejected, error, invited.
user[w2_employee_id]
opcional

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

Validations:

  • Must be a String
user[drug_tested]
opcional

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

Validations:

  • Must be one of: passed, failed.
user[verified_phone]
opcional

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

Validations:

  • Must be a String
user[phone_verified_at]
opcional

This attribute is used for Workers only.

Validations:

  • Must be a DateTime
user[user_badges_attributes]
opcional

Badges that the Worker has. This attribute is used for Workers only.

Validations:

  • Must be a Hash
user[user_badges_attributes][badge_id]
requerido

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

Validations:

  • Must be a Integer
user[user_badges_attributes][id]
opcional

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:

  • Must be a Integer
user[user_badges_attributes][_destroy]
opcional

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

Validations:

  • Must be one of: true, false, 1, 0.
user[title]
opcional

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

Validations:

  • Must be a String
user[role]
requerido

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

Validations:

  • Must be one of: customer_admin, requestor, read_only.
user[customer_id]
requerido

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

Validations:

  • Must be a Integer