カタログ・フィールドを削除する
delete
/catalogs/{catalog_name}/fields/{field_name}
カタログ・フィールドを削除するには、このエンドポイントを使用する。
important:
このエンドポイントは現在早期アクセス中である。この早期アクセスへ参加することに興味がある場合は、カスタマーサクセスマネージャーにお問い合わせください。
前提条件
このエンドポイントを使用するには、API キーとcatalogs.delete_fields
の権限が必要です。
レート制限
パスパラメーター
パラメータ | 必須 | データ型 | 説明 |
---|---|---|---|
catalog_name |
必須 | 文字列 | カタログ名。 |
field_name |
必須 | 文字列 | カタログ・フィールドの名前。 |
例のリクエスト
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' \
応答
このエンドポイントには2つのステータスコード応答があります: 202
と 404
。
成功応答の例
ステータスコード 202
は、次の応答本文を返す可能性があります。
1
2
3
{
"message": "success"
}
エラー応答例
ステータスコード 404
は、次の応答本文を返す可能性があります。遭遇する可能性のあるエラーの詳細については、「トラブルシューティング」を参照のこと。
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"
}
トラブルシューティング
以下の表は、返される可能性のあるエラーと、それに関連するトラブルシューティングの手順を示したものである。
エラー | トラブルシューティング |
---|---|
catalog-not-found |
カタログ名が有効であることを確認する。 |
field-referenced-by-selection |
カタログフィールドが現在選択によって使用されていることを確認する。 |
field-is-inventory |
カタログ・フィールドがインベントリ・フィールドとして使用されていることを確認する。 |
invalid-field-name |
カタログフィールド名が有効であることを確認する。 |
New Stuff!