Skip to content

Excluir catálogo

delete

/catalogs/{catalog_name}

Use este endpoint para excluir um catálogo.

Pré-requisitos

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

Limite de taxa

Esse endpoint tem um limite de taxa compartilhado de 50 solicitações por minuto entre todos os endpoints de catálogo síncronos, 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.

Exemplo de solicitação

1
2
3
curl --location --request DELETE 'https://rest.iad-03.braze.com/catalogs/restaurants' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \

Resposta

Existem dois códigos de status para este endpoint: 200 e 404.

Exemplo de resposta bem-sucedida

O código de status 200 poderia retornar o seguinte corpo de resposta:

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

Exemplo de resposta de erro

O código de status 404 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
12
13
14
15
{
  "errors": [
    {
      "id": "catalog-not-found",
      "message": "Could not find catalog",
      "parameters": [
        "catalog_name"
      ],
      "parameter_values": [
        "restaurants"
      ]
    }
  ],
  "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.
New Stuff!