Passer au contenu principal
PUT
/
settings
/
v3
/
users
/
{userId}
Modifier un utilisateur.
curl --request PUT \
  --url https://api.hubapi.com/settings/v3/users/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "primaryTeamId": "<string>",
  "roleId": "<string>",
  "secondaryTeamIds": [
    "<string>"
  ]
}
'
{
  "email": "<string>",
  "id": "<string>",
  "roleIds": [
    "<string>"
  ],
  "superAdmin": true,
  "firstName": "<string>",
  "lastName": "<string>",
  "primaryTeamId": "<string>",
  "roleId": "<string>",
  "secondaryTeamIds": [
    "<string>"
  ],
  "sendWelcomeEmail": true
}

Supported products

Autorisations

Authorization
string
header
requis

The access token received from the authorization server in the OAuth 2.0 flow.

Paramètres de chemin

userId
string
requis

Paramètres de requête

idProperty
enum<string>
Options disponibles:
EMAIL,
USER_ID

Corps

application/json
firstName
string

Le prénom de l'utilisateur.

lastName
string

Le nom de famille de l'utilisateur.

primaryTeamId
string

L'équipe principale de l'utilisateur.

roleId
string

Le rôle de l'utilisateur.

secondaryTeamIds
string[]

Les équipes supplémentaires de l'utilisateur.

Réponse

successful operation

email
string
requis

L'e-mail de l'utilisateur.

id
string
requis

L'identifiant unique de l'utilisateur.

roleIds
string[]
requis

Une liste des ID de rôle attribués à l'utilisateur.

superAdmin
boolean
requis

Si l'utilisateur dispose des privilèges de super administrateur.

firstName
string

Le prénom de l'utilisateur.

lastName
string

Le nom de famille de l'utilisateur.

primaryTeamId
string

L'équipe principale de l'utilisateur

roleId
string

Le rôle de l'utilisateur.

secondaryTeamIds
string[]

Les équipes supplémentaires de l'utilisateur.

sendWelcomeEmail
boolean

Si un e-mail de bienvenue a été envoyé à l'utilisateur. Cette valeur ne sera renseignée qu'en réponse à une demande de provisioning. Les requêtes suivantes renverront la valeur « faux ».

Last modified on April 13, 2026