Skip to content

Supprimer un champ du catalogue

delete

/catalogs/{catalog_name}/fields/{field_name}

Utilisez cet endpoint pour supprimer un champ de catalogue.

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation catalogs.delete_fields.

Limite de débit

Cet endpoint a une limite de débit partagée de 50 requêtes par minute entre tous les endpoints de champs et sélections de catalogues asynchrones, comme documenté dans Limites de débit de l’API.

Paramètres de chemin

Paramètre Requis Type de données Description
catalog_name Requis Chaîne de caractères Nom du catalogue.
field_name Requis Chaîne de caractères Nom du champ du catalogue.

Exemple de requête

1
2
3
curl --location --request DELETE 'https://rest.iad-03.braze.com/catalogs/restaurants/fields/ratings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \

Réponse

Deux codes de statut de réponse existent pour cet endpoint : 202 et 404.

Exemple de réponse réussie

Le code de statut 202 pourrait renvoyer le corps de réponse suivant :

1
2
3
{
  "message": "success"
}

Exemple de réponse échouée

Le code de statut 404 pourrait renvoyer le corps de réponse suivant. Consultez la section Résolution des problèmes pour plus d’informations sur les erreurs que vous pourriez rencontrer.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "errors": [
    {
      "id": "catalog-not-found",
      "message": "Could not find catalog",
      "parameters": [
        "catalog_name"
      ],
      "parameter_values": [
        "restaurants"
      ]
    }
  ],
  "message": "Invalid Request"
}

Résolution des problèmes

Le tableau suivant répertorie les erreurs possibles et les étapes de résolution des problèmes associées.

Erreur Résolution des problèmes
catalog-not-found Vérifiez que le nom du catalogue est valide.
field-referenced-by-selection Vérifiez que le champ du catalogue est actuellement utilisé par une sélection.
field-is-inventory Vérifiez que le champ du catalogue est utilisé comme champ d’inventaire.
invalid-field-name Vérifiez que le nom du champ du catalogue est valide.
New Stuff!