Excluir relacionamento de objeto

Use este endpoint para excluir uma aresta de relacionamento entre objetos.

Importante

Data Objects está em disponibilidade geral, mas seu espaço de trabalho precisa ser provisionado para Accounts antes que você possa usar este endpoint. Para solicitar o provisionamento, acesse Configurações de dados > Accounts e preencha o questionário. Para mais detalhes, consulte Ativar Accounts.

Pré-requisitos

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

Limite de frequência

Este endpoint está no bucket de escrita de Data Objects, com um limite padrão de 1.000 solicitações por minuto.

Parâmetros de caminho

A tabela a seguir lista e descreve os parâmetros de caminho do endpoint /data_objects/objects/{type_name}/{object_id}/object_relationships.

Parâmetros de solicitação

A tabela a seguir lista e descreve os parâmetros do corpo da solicitação JSON do endpoint /data_objects/objects/{type_name}/{object_id}/object_relationships.

Nota

Este endpoint DELETE espera um corpo de solicitação JSON. Verifique se o seu cliente HTTP envia corpos de solicitação em chamadas DELETE.

Exemplo de solicitação

Esta seção inclui uma carga útil JSON de exemplo e uma solicitação cURL de exemplo.

Exemplo de carga útil da solicitação

1
2
3
4
5

{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_object_id": "acct-456"
}

Exemplo de solicitação cURL

Este exemplo remove o relacionamento subaccount entre acct-123 e acct-456. Os dois registros de conta são mantidos.

1
2
3
4
5
6
7
8

curl --location --request DELETE 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123/object_relationships' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_object_id": "acct-456"
}'

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 }

Parâmetros de resposta

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

Erros

A tabela a seguir lista os erros comuns deste endpoint e como resolvê-los.