Mettre à jour l'attribut utilisateur

Version 3.1.23.2

Modifiez une définition d'attribut utilisateur.

Demande

PATCH /user_attributes/{ID_attribut_utilisateur}
Type de données
Description
Demande
HTTPRequest
chemin d'accès
Chemin HTTP
Développer la définition HTTPPath...
id_attribut_utilisateur
integer
ID de l'attribut utilisateur
body
Corps HTTP
Développer la définition HTTPBody...
body
Attribut utilisateur
Développer la définition de l'attribut utilisateur
peut
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
id
integer
Identifiant unique
name
string
Nom de l'attribut utilisateur
label
string
Libellé lisible pour l'attribut utilisateur
type
string
Type d'attribut utilisateur ("chaîne", "nombre", "datetime", "yesno", "code postal")
default_value
string
Valeur par défaut lorsqu'aucune valeur n'est définie pour l'utilisateur
Is_system
booléen
L'attribut est un paramètre système par défaut
est_permanent
booléen
L'attribut est définitif et ne peut pas être supprimé
valeur_est_masquée
booléen
Si la valeur est "true", les utilisateurs ne pourront pas afficher les valeurs de cet attribut
visionnage_utilisateur
booléen
Les utilisateurs qui ne sont pas administrateurs peuvent voir les valeurs de leurs attributs et les utiliser dans les filtres
Modification par l'utilisateur
booléen
Les utilisateurs peuvent modifier la valeur de cet attribut pour eux-mêmes
domaine_valeur_masquée_liste_blanche
string
Destinations vers lesquelles un attribut masqué peut être envoyé. Une fois défini, ce paramètre ne peut plus être modifié.
query
Requête HTTP
Développer la définition de la requête HTTP...
champs
string
Champs demandés.

Réponse

200: Attribut utilisateur

Type de données
Description
peut
objet
Opérations que l'utilisateur actuel peut effectuer sur cet objet
id
integer
Identifiant unique
name
string
Nom de l'attribut utilisateur
label
string
Libellé lisible pour l'attribut utilisateur
type
string
Type d'attribut utilisateur ("chaîne", "nombre", "datetime", "yesno", "code postal")
default_value
string
Valeur par défaut lorsqu'aucune valeur n'est définie pour l'utilisateur
Is_system
booléen
L'attribut est un paramètre système par défaut
est_permanent
booléen
L'attribut est définitif et ne peut pas être supprimé
valeur_est_masquée
booléen
Si la valeur est "true", les utilisateurs ne pourront pas afficher les valeurs de cet attribut
visionnage_utilisateur
booléen
Les utilisateurs qui ne sont pas administrateurs peuvent voir les valeurs de leurs attributs et les utiliser dans les filtres
Modification par l'utilisateur
booléen
Les utilisateurs peuvent modifier la valeur de cet attribut pour eux-mêmes
domaine_valeur_masquée_liste_blanche
string
Destinations vers lesquelles un attribut masqué peut être envoyé. Une fois défini, ce paramètre ne peut plus être modifié.

400 Bad Request

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

404: introuvable

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

422: Erreur de validation

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
Développer la définition de ValidationErrorDetail...
champ
string
Champ comportant une erreur
code
string
Code d'erreur
Message
string
Message d'information sur l'erreur
documentation_url
string
Lien vers la documentation
documentation_url
string
Lien vers la documentation

429 : Too Many Requests

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation