Excluir campo de catálogo
/catalogs/{catalog_name}/fields/{field_name}
Use esse ponto de extremidade para excluir um campo de catálogo.
Esse ponto de extremidade está atualmente em acesso antecipado. Entre em contato com seu gerente de sucesso do cliente se tiver interesse em participar desse acesso antecipado.
Pré-requisitos
Para usar esse endpoint, você precisará de uma chave de API com a permissão catalogs.delete_fields
.
Limite de taxa
This endpoint has a shared rate limit of 50 requests per minute between all asynchronous catalog fields and selections endpoints, as documented in API rate limits.
Parâmetros da jornada
Parâmetro | Obrigatória | Tipo de dados | Descrição |
---|---|---|---|
catalog_name |
Obrigatória | String | Nome do catálogo. |
field_name |
Obrigatória | String | Nome do campo do catálogo. |
Exemplo de solicitação
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' \
Resposta
Existem dois códigos de status para este endpoint: 202
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 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.
Erro | Solução de problemas |
---|---|
catalog-not-found |
Verifique se o nome do catálogo é válido. |
field-referenced-by-selection |
Verifique se o campo de catálogo está sendo usado atualmente por uma seleção. |
field-is-inventory |
Verifique se o campo de catálogo é usado como um campo de inventário. |
invalid-field-name |
Verifique se o nome do campo do catálogo é válido. |