Update user – Referencia de la API – Integraciones

Parámetros de ruta

Nombre	Tipo	Obligatorio	Descripción
`user_id`	string	obligatorio	Parámetro de ruta: user_id

Cuerpo de la solicitud

Content-Type: application/json

Campo	Tipo	Obligatorio	Descripción
`user_id`	string (uuid)	obligatorio	user_id
`username`	string	opcional	Username
`password`	string	opcional	Password
`employee_id`	string	opcional	Employee ID
`external_id`	string	opcional	External ID
`group_ids`	object	opcional	The COMPLETE set of groups this user should belong to, not an addition (BGR-1225). Omitting a group the user is currently in removes that membership, so a request that would remove one or more memberships is refused with 412 group_removal_requires_confirmation, naming those groups, instead of deleting them silently. Send the full current set plus your additions to keep an update additive, or set confirm_group_removal=true to accept the removals. Omit or leave empty to leave the user's groups untouched.
`confirm_group_removal`	boolean	opcional	BGR-1225: confirms the memberships this update would delete. group_ids is a complete desired set, so omitting a group the user is currently in deletes that membership; by default the endpoint answers 412 group_removal_requires_confirmation and names the groups rather than deleting them silently. Send true only when the removals are intended. A purely additive group_ids never needs this flag. By default false.
`subscription_id`	string (uuid)	opcional	Subscription ID
`auto_license`	boolean	opcional	Auto License
`active`	boolean	opcional	Is Active Bool
`notify_on_update`	boolean	opcional	Is Not Notify
`city`	string	opcional	City
`company`	string	opcional	Company
`custom_fields`	array	opcional	Extra
`id`	string (uuid)	obligatorio	Custom field id
`value`	string	obligatorio	Custom field value
`first_name`	string	opcional	First Name
`last_name`	string	opcional	Last Name
`national_id`	string	opcional	National ID
`email`	string (email)	opcional	Email
`phone_number`	string (phone)	opcional	Phone Number
`gender`	string	opcional	gender enum: `m`, `f`
`center`	string	opcional	Center
`position`	string	opcional	Position
`department`	string	opcional	Department
`date_of_birth`	string (date)	opcional	Date of Birth YYYY-MM-DD

Respuestas

200

Esquema de application/json

{
  "type": "object",
  "nullable": true
}

412 Invalid parameters

500 Server error

512 Specification violations