Skip to content

Excluir vários itens do catálogo

delete

/catalogs/{catalog_name}/items

Use esse endpoint para excluir vários itens do seu catálogo.

Cada solicitação pode suportar até 50 itens. Esse endpoint é assíncrono.

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão catalogs.delete_items.

Limite de taxa

Esse endpoint tem um limite de taxa compartilhado de 16.000 solicitações por minuto entre todos os endpoints assíncronos de itens de catálogo, conforme documentado em Limites de taxa da API.

Parâmetros de jornada

Parâmetro Obrigatória Tipo de dados Descrição
catalog_name Obrigatória String Nome do catálogo.

Parâmetros de solicitação

Parâmetro Obrigatória Tipo de dados Descrição
items Obrigatória Vetor Um vetor que contém objetos de item. Os objetos de item devem conter um id referenciando os itens que a Braze deve excluir. São permitidos até 50 objetos de item por solicitação.

Exemplo de solicitação

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"}
  ]
}'

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 saber mais sobre os erros que você pode encontrar.

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"
}

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
catalog-not-found Verifique se o nome do catálogo é válido.
ids-too-large Os IDs de item não podem ter mais de 250 caracteres.
ids-not-unique Verifique se os IDs de item são exclusivos na solicitação.
ids-not-strings Os IDs de item devem ser do tipo string.
items-missing-ids Alguns itens não têm IDs de item. Verifique se cada item tem um ID de item.
invalid-ids Os IDs de item só podem conter letras, números, hifens e underscores.
request-includes-too-many-items Sua solicitação tem muitos itens. O limite de itens por solicitação é de 50.
New Stuff!