Allo

Vue d'ensemble

Gérez les champs personnalisés des contacts dans votre CRM Allo

Mis à jour le

Les champs personnalisés ajoutent vos propres données aux personnes, comme une source de lead ou un budget. L'API Champs personnalisés vous permet de lister, créer, modifier et supprimer les champs définis sur votre équipe.

Scopes

ScopeAccès
CRM_READLister les champs personnalisés, et lire custom_attributes sur les personnes
CRM_WRITECréer et modifier des champs personnalisés, et renseigner custom_attributes sur les personnes
CRM_DELETESupprimer des champs personnalisés

Définir un champ, puis renseigner sa valeur

Un champ personnalisé n'est que la définition. Les valeurs se trouvent sur chaque personne, dans custom_attributes.

  1. Définissez le champ avec Créer un champ personnalisé, par exemple Lead Source de type TEXT. Notez la key renvoyée, ici lead_source.
  2. Renseignez sa valeur avec custom_attributes sur Créer une personne ou Mettre à jour une personne : { "custom_attributes": { "lead_source": "Webinar" } }.
  3. Relisez-la dans custom_attributes sur Obtenir une personne et Rechercher des personnes.

Seules les clés envoyées sont écrites, et null efface une valeur. Les erreurs de clé et de type sont renvoyées sous les codes CUSTOM_ATTRIBUTE_KEY_UNKNOWN et CUSTOM_ATTRIBUTE_VALUE_INVALID. Les réponses de personnes incluent toujours custom_attributes, sans les champs archivés ni les valeurs vides. La recherche ne peut pas filtrer ni trier sur les champs personnalisés.

Types de champs

TypeNotes
TEXT
NUMBER
DATE
BOOLEAN
DROPDOWNUne valeur parmi une liste fixe d'options, chacune avec une key et un label. Les champs synchronisés depuis vos intégrations CRM peuvent aussi être des listes déroulantes.

Clés

Chaque champ a une key, dérivée de son label : minuscules, accents supprimés, séquences de caractères non alphanumériques remplacées par _, tronquée à 64 caractères. Lead Source devient lead_source.

Limites

Une équipe peut avoir jusqu'à 150 champs personnalisés TEXT, 50 NUMBER, 30 DATE et 30 BOOLEAN. Les champs DROPDOWN comptent dans la limite des TEXT. Créer un champ au-delà de la limite de son type renvoie ATTRIBUTE_SLOTS_EXHAUSTED.

Modifier et supprimer des champs

Mettre à jour un champ personnalisé modifie le label, la description et les options d'une liste déroulante. La key et le type ne changent jamais. Les champs synchronisés depuis une intégration CRM ne peuvent être ni modifiés ni supprimés, et les champs natifs comme name ou company ne sont pas des champs personnalisés.

Les champs personnalisés sont disponibles sur les espaces de travail qui utilisent le nouveau modèle de contacts. Les autres espaces reçoivent une erreur 404 TEAM_NOT_FOUND.

Endpoints