Supprimer un champ du catalogue
/catalogs/{catalog_name}/fields/{field_name}
Utilisez cet endpoint pour supprimer un champ de catalogue.
Cet endpoint est actuellement en accès anticipé. Contactez votre gestionnaire de satisfaction client si vous souhaitez participer à cet accès anticipé.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation catalogs.delete_fields
.
Limite de débit
This endpoint has a shared rate limit of 50 requests per minute between all asynchronous catalog fields and selections endpoints, as documented in API rate limits.
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 demande
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 réponses de code de statut 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 résolution des problèmes pour plus d’informations concernant 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 renvoyées 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. |