Excluir um item do catálogo
delete
/catalogs/{catalog_name}/items/{item_id}
Use esse ponto de extremidade para excluir um item em seu catálogo.
Pré-requisitos
Para usar esse endpoint, você precisará de uma chave de API com a permissão catalogs.delete_item
.
Limite de taxa
Parâmetros da jornada
Parâmetro | Obrigatória | Tipo de dados | Descrição |
---|---|---|---|
catalog_name |
Obrigatória | String | Nome do catálogo. |
item_id |
Obrigatória | String | A ID do item do catálogo. |
Parâmetros de solicitação
Não há corpo de solicitação para esse endpoint.
Exemplo de solicitação
1
2
3
curl --location --request DELETE 'https://rest.iad-03.braze.com/catalogs/restaurants/items/restaurant1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
Resposta
Há três respostas de código de status para esse endpoint: 202
, 400
e 404
.
Exemplo de resposta bem-sucedida
O código de status 202
poderia retornar o seguinte corpo de resposta.
1
2
3
{
"message": "success"
}
Exemplo de resposta de erro
O código de status 400
poderia retornar o seguinte corpo de resposta. Consulte Solução de problemas para obter mais informações sobre os erros que você pode encontrar.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"errors": [
{
"id": "item-not-found",
"message": "Could not find item",
"parameters": [
"item_id"
],
"parameter_values": [
"restaurant34"
]
}
],
"message": "Invalid Request"
}
Solução de problemas
A tabela a seguir lista os possíveis erros retornados e as etapas de solução de problemas associadas.
Erro | Solução de problemas |
---|---|
arbitrary-error |
Ocorreu um erro arbitrário. Tente novamente ou entre em contato com o suporte. |
catalog-not-found |
Verifique se o nome do catálogo é válido. |
item-not-found |
Verifique se o item a ser excluído existe em seu catálogo. |
New Stuff!