Synupv1
Créer une clé
v1Ressources/Champs personnalisés/patchMettre à jour une définition de champ personnalisé

Mettre à jour une définition de champ personnalisé

Modifie l'étiquette, l'indicateur requis, les options ou l'ordre d'affichage d'une définition de champ personnalisé. Le type et la clé du champ ne peuvent pas être modifiés après création.

patch/api/v1/custom-fields/definitions
custom-fields:write
Corps de la requête
definitionIdstringobligatoire
ID de la définition de champ personnalisé à mettre à jour.
labelstringfacultatif
L'étiquette d'affichage du champ personnalisé.
requiredbooleanfacultatif
Si le champ doit être marqué comme requis. Facultatif ; par défaut false.
optionsarray of stringfacultatif
Les options sélectionnables du champ. Requises (au moins une) pour les champs single_select et multi_select ; ignorées pour les autres types.
ordernumberfacultatif
Nouvel ordre d'affichage pour cette définition par rapport aux autres du même type d'entité.
Réponse
dataobjectfacultatif
definitionobjectfacultatif
idstringfacultatif
Identifiant unique de la définition de champ personnalisé.
entityTypestring (location | client)facultatif
Le type d'entité auquel cette définition s'applique : "location" ou "client".
keystringfacultatif
Slug immuable identifiant ce champ, dérivé de son étiquette à la création. Utilisez-le pour référencer le champ lors de la définition de valeurs.
labelstringfacultatif
L'étiquette d'affichage du champ personnalisé.
typestring (text | number | date | single_select | multi_select)facultatif
Le type de valeur du champ.
requiredbooleanfacultatif
Si le champ est marqué comme requis. Ce n'est pas imposé par l'API — c'est uniquement une indication pour l'interface.
optionsarray of stringfacultatif
Les options sélectionnables du champ, pour les champs single_select et multi_select. Null pour les autres types.
createdBystringfacultatif
Qui a créé cette définition de champ : "user" ou "agent".
ordernumberfacultatif
L'ordre d'affichage du champ par rapport aux autres définitions du même type d'entité, du plus bas au plus élevé.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
422Il manque un paramètre requis à la requête, ou elle est invalide.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
patch/api/v1/custom-fields/definitions
Votre clé API
Corps de la requête*
{
  "data": {
    "definition": {
      "id": "cm_def_abc123",
      "entityType": "location",
      "key": "parking_notes",
      "label": "Parking notes",
      "type": "text",
      "required": true,
      "options": null,
      "createdBy": "user",
      "order": 0
    }
  }
}