Skip to content

Excluir objeto personalizado

delete

/custom_objects/objects/{type_name}/{external_id}

Use este endpoint para excluir um objeto personalizado.

Pré-requisitos

Para usar este endpoint, você precisa de uma chave de API com a permissão custom_objects.delete.

Limite de frequência

Este endpoint está no bucket de escrita de objetos personalizados com um limite padrão de 50 solicitações por minuto.

Parâmetros de caminho

A tabela a seguir lista e descreve os parâmetros de caminho para o endpoint /custom_objects/objects/{type_name}/{external_id}.

Parâmetro Obrigatório Tipo de dados Descrição
type_name Obrigatório String Nome de máquina do tipo de objeto personalizado
external_id Obrigatório String Identificador do objeto

Exemplo de solicitação

Esta seção inclui um exemplo de carga útil de parâmetros de caminho e um exemplo de solicitação cURL.

Exemplo de carga útil da solicitação

Use este objeto JSON como referência para os parâmetros de caminho desta solicitação.

1
2
3
4

{
  "type_name": "account",
  "external_id": "acct-123"
}

Exemplo de solicitação cURL

Este exemplo exclui o registro de conta acct-123.

1
2

curl --location --request DELETE 'https://rest.iad-01.braze.com/custom_objects/objects/account/acct-123' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Resposta

Esta seção inclui um exemplo de resposta bem-sucedida e os campos da resposta.

Exemplo de resposta bem-sucedida

O código de status 200 pode retornar o seguinte corpo de resposta.

1

{ "deleted": true }

A exclusão é síncrona. Excluir um objeto não exclui objetos relacionados.

Parâmetros da resposta

A tabela a seguir lista e descreve os campos em uma resposta bem-sucedida.

Parâmetro Obrigatório Tipo de dados Descrição
deleted Obrigatório Booleano Se a exclusão do objeto foi bem-sucedida

Erros

A tabela a seguir lista erros comuns para este endpoint e como resolvê-los.

Status Causa Orientação
404 Tipo não encontrado ou objeto não encontrado Confirme que type_name e external_id existem no espaço de trabalho.
401 Chave da API REST ausente ou inválida Verifique se o cabeçalho Authorization usa Bearer YOUR_REST_API_KEY e se a chave está ativa.
403 A chave de API não possui permissão ou a solicitação está bloqueada pela lista de permissões Confirme que a chave possui custom_objects.delete e que o IP de origem está na lista de permissões da chave, se configurada.
429 Limite de frequência excedido Tente novamente após X-RateLimit-Reset e reduza a frequência das solicitações.
New Stuff!