v1Ressources/Champs personnalisés/deleteArchiver une définition de champ personnalisé

Archiver une définition de champ personnalisé

Archive une définition de champ personnalisé afin qu'elle n'apparaisse plus dans le schéma et n'accepte plus de nouvelles valeurs. Les valeurs déjà stockées sous sa clé ne sont pas affectées. Un definitionId inconnu ou déjà archivé n'a aucun effet, ce n'est pas une erreur.

delete/api/v1/custom-fields/definitions

custom-fields:write

Paramètres de requête

definitionIdstringobligatoire

ID de la définition de champ personnalisé à archiver.

Réponse

dataobjectfacultatif

archivedbooleanfacultatif

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.

429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.

delete/api/v1/custom-fields/definitions

Votre clé API

definitionId *

{
  "data": {
    "archived": true
  }
}