Excluir relacionamento de usuário

Use este endpoint para remover um relacionamento entre usuário e objeto.

Importante

Custom Objects está atualmente em acesso antecipado. Seu espaço de trabalho precisa estar ativado antes que as permissões de chave de API de Custom Objects apareçam em Configurações > Chaves de API.

Pré-requisitos

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

Limite de frequência

Este endpoint está no bucket de escrita de Custom Objects 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}/users.

Parâmetros de solicitação

A tabela a seguir lista e descreve os parâmetros do corpo da solicitação JSON para o endpoint /custom_objects/objects/{type_name}/{external_id}/users.

Nota

Este endpoint DELETE espera um corpo de solicitação em JSON. Confirme que 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.

Carga útil de solicitação de exemplo

1
2
3
4
{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user"
}

Solicitação cURL de exemplo

Este exemplo remove o relacionamento account_user entre o usuário especificado e acct-123. O perfil de usuário e o registro da conta permanecem.

1
2
3
4
5
6
7
curl --location --request DELETE 'https://rest.iad-01.braze.com/custom_objects/objects/account/acct-123/users' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user"
}'

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 em uma resposta bem-sucedida.

Erros

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