Skip to content

Mehrere Katalogartikel löschen

delete

/catalogs/{catalog_name}/items

Verwenden Sie diesen Endpunkt, um mehrere Artikel in Ihrem Katalog zu löschen.

Jede Anfrage kann bis zu 50 Artikel enthalten. Dieser Endpunkt ist asynchron.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung catalogs.delete_items.

Rate-Limits

Für diesen Endpunkt gilt ein gemeinsames Rate-Limit von 16.000 Anfragen pro Minute für alle asynchronen Katalogeintrags-Endpunkte, wie in API-Rate-Limits dokumentiert.

Pfad-Parameter

Parameter Erforderlich Datentyp Beschreibung
catalog_name Erforderlich String Name des Katalogs.

Anfrage-Parameter

Parameter Erforderlich Datentyp Beschreibung
items Erforderlich Array Ein Array, das Artikel-Objekte enthält. Die Artikel-Objekte sollten eine id enthalten, die auf die Artikel verweist, die Braze löschen soll. Es sind bis zu 50 Artikel-Objekte pro Anfrage zulässig.

Beispielanfrage

1
2
3
4
5
6
7
8
9
10
curl --location --request DELETE 'https://rest.iad-03.braze.com/catalogs/restaurants/items' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "items": [
    {"id": "restaurant1"},
    {"id": "restaurant2"},
    {"id": "restaurant3"}
  ]
}'

Antwort

Es gibt drei Statuscode-Antworten für diesen Endpunkt: 202, 400 und 404.

Beispiel für eine erfolgreiche Antwort

Der Statuscode 202 könnte den folgenden Antwortkörper zurückgeben.

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

Beispiel für eine Fehlerantwort

Der Statuscode 400 könnte den folgenden Antwortkörper zurückgeben. Unter Fehlerbehebung finden Sie weitere Informationen zu Fehlern, die bei Ihnen auftreten können.

1
2
3
4
5
6
7
8
9
10
11
{
  "errors": [
    {
      "id": "items-missing-ids",
      "message": "There are 1 item(s) that do not have ids",
      "parameters": [],
      "parameter_values": []
    }
  ],
  "message": "Invalid Request"
}

Fehlerbehebung

In der folgenden Tabelle finden Sie eine Liste möglicher zurückgegebener Fehler und die entsprechenden Schritte zur Fehlerbehebung.

Fehler Fehlerbehebung
catalog-not-found Prüfen Sie, ob der Katalogname gültig ist.
ids-too-large Artikel-IDs dürfen nicht mehr als 250 Zeichen lang sein.
ids-not-unique Prüfen Sie, ob die Artikel-IDs in der Anfrage eindeutig sind.
ids-not-strings Artikel-IDs müssen vom Typ String sein.
items-missing-ids Einige Artikel haben keine Artikel-IDs. Prüfen Sie, ob jeder Artikel eine ID hat.
invalid-ids Artikel-IDs dürfen nur Buchstaben, Zahlen, Bindestriche und Unterstriche enthalten.
request-includes-too-many-items Ihre Anfrage enthält zu viele Artikel. Die Anzahl der Artikel pro Anfrage ist auf 50 begrenzt.
New Stuff!