Excluir catálogo

Use esse ponto de extremidade para excluir um catálogo.

Pré-requisitos

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

Limite de taxa

Esse endpoint tem um limite de frequência compartilhado de 50 solicitações por minuto entre todos os endpoints de catálogo síncrono, conforme documentado em Limites de frequência da API.

Parâmetros da jornada

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 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": "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.