Skip to main content
PUT
/
settings
/
v3
/
users
/
{userId}
Modifica un usuario
curl --request PUT \
  --url https://api.hubapi.com/settings/v3/users/{userId} \
  --header 'Content-Type: application/json' \
  --header 'private-app: <api-key>' \
  --data '{
  "roleId": "100",
  "primaryTeamId": "101",
  "secondaryTeamIds": [
    "102"
  ]
}'
{
  "id": "123",
  "email": "newUser@email.com",
  "roleId": "100",
  "primaryTeamId": "101",
  "secondaryTeamIds": [
    "102"
  ],
  "superAdmin": "false"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Gratuito
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito
Esta API requiere uno de los siguientes ámbitos:
crm.objects.users.write
settings.users.write

Authorizations

​
private-app
string
header
required

Path Parameters

​
userId
string
required

Identificador del usuario que se recuperará

Query Parameters

​
idProperty
enum<string>

El nombre de una propiedad con valores de usuario únicos. Los valores válidos son "USER_ID" (predeterminado) o "EMAIL"

Available options:
USER_ID,
EMAIL

Body

application/json

A user to update

​
firstName
string

El nombre del usuario.

​
lastName
string

El apellido del usuario.

​
primaryTeamId
string

El equipo principal del usuario.

​
roleId
string

El rol del usuario.

​
secondaryTeamIds
string[]

Los equipos adicionales del usuario.

Response

successful operation

A user

​
id
string
required

El ID único del usuario.

​
email
string
required

El correo electrónico del usuario.

​
firstName
string

El nombre del usuario.

​
lastName
string

El apellido del usuario.

​
primaryTeamId
string

El equipo principal del usuario

​
roleIds
string[]

Una lista de los ID de rol asignados al usuario.

​
sendWelcomeEmail
boolean

Si se envió un correo electrónico de bienvenida al usuario. Este valor solo se rellenará en respuesta a una solicitud de aprovisionamiento. Las consultas posteriores serán falsas.

​
roleId
string

El rol del usuario.

​
secondaryTeamIds
string[]

Los equipos adicionales del usuario.

​
superAdmin
boolean

Si el usuario tiene privilegios de superadministrador.