v1Ressources/Champs personnalisés/putDéfinir une valeur de champ personnalisé

Définir une valeur de champ personnalisé

Définit une valeur de champ personnalisé sur un établissement ou un client. Passez null (ou une valeur vide) pour vider le champ. La valeur est validée par rapport à la définition du champ — par exemple, la valeur d'un champ select doit être une de ses options définies.

put/api/v1/custom-fields/values

custom-fields:write

Corps de la requête

entityTypestring (location | client)obligatoire

Le type d'entité auquel ce champ s'applique : "location" ou "client".

entityIdstringobligatoire

ID de l'établissement ou du client sur lequel définir la valeur.

keystringobligatoire

Clé de la définition de champ personnalisé à définir, telle que renvoyée dans sa propriété key.

valueobjectobligatoire

La valeur à stocker. Doit être présente dans le corps de la requête, mais peut être null ou vide pour vider le champ. Validée par rapport au type et aux options du champ.

Réponse

dataobjectfacultatif

valuesobjectfacultatif

Les valeurs de champs personnalisés de l'entité, indexées par clé de champ. Une valeur est une chaîne, un nombre, un tableau de chaînes (pour multi_select), ou absente si non définie.

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.

put/api/v1/custom-fields/values

Votre clé API

Corps de la requête*

{
  "data": {
    "values": {
      "parking_notes": "Free lot behind the building."
    }
  }
}