Zum Hauptinhalt springen
PUT
/
settings
/
v3
/
users
/
{userId}
Ändert einen Benutzer
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"
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Kostenlos
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Kostenlos
Diese API erfordert einen der folgenden Bereiche:
crm.objects.users.write
settings.users.write

Authorizations

​
private-app
string
header
required

Path Parameters

​
userId
string
required

ID des Benutzers, für den Daten abgerufen werden sollen

Query Parameters

​
idProperty
enum<string>

Der Name einer Eigenschaft mit eindeutigen Benutzerwerten. Gültige Werte sind „USER_ID“ (Standard) oder „EMAIL“.

Verfügbare Optionen:
USER_ID,
EMAIL

Body

application/json

A user to update

​
firstName
string

Der Vorname des Benutzers.

​
lastName
string

Der Nachname des Benutzers.

​
primaryTeamId
string

Das primäre Team des Benutzers.

​
roleId
string

Die Rolle des Benutzers.

​
secondaryTeamIds
string[]

Die weiteren Teams des Benutzers.

Response

successful operation

A user

​
id
string
required

Die eindeutige ID des Benutzers.

​
email
string
required

Die E-Mail des Benutzers.

​
firstName
string

Der Vorname des Benutzers.

​
lastName
string

Der Nachname des Benutzers.

​
primaryTeamId
string

Das primäre Team des Benutzers

​
roleIds
string[]

Eine Liste der Rollen-IDs, die dem Benutzer zugewiesen sind.

​
sendWelcomeEmail
boolean

Ob eine Begrüßungs-E-Mail an den Benutzer gesendet wurde. Dieser Wert wird nur in Reaktion auf einen Bereitstellungsantrag engetragen. Nachfolgende Anfragen erhalten den Wert „false“.

​
roleId
string

Die Rolle des Benutzers.

​
secondaryTeamIds
string[]

Die weiteren Teams des Benutzers.

​
superAdmin
boolean

Ob der Benutzer Super-Admin-Berechtigungen besitzt.