Eliminar relación de usuario

Usa este endpoint para eliminar una relación entre un usuario y un objeto.

Importante

Los objetos de datos se encuentran actualmente en acceso anticipado. Tu espacio de trabajo debe estar habilitado antes de que los permisos de clave de API de objetos de datos aparezcan en Configuración > Claves de API.

Requisitos previos

Para usar este endpoint, necesitas una clave de API con el permiso data_objects.user_relationships.delete.

Límite de velocidad

Este endpoint se encuentra en el contenedor de escritura de objetos de datos con un límite predeterminado de 50 solicitudes por minuto.

Parámetros de ruta

La siguiente tabla enumera y describe los parámetros de ruta para el endpoint /data_objects/objects/{type_name}/{external_id}/users.

Parámetros de solicitud

La siguiente tabla enumera y describe los parámetros del cuerpo de la solicitud JSON para el endpoint /data_objects/objects/{type_name}/{external_id}/users.

Nota

Este endpoint DELETE espera un cuerpo de solicitud JSON. Valida que tu cliente HTTP envíe cuerpos de solicitud en las llamadas DELETE.

Ejemplo de solicitud

Esta sección incluye un ejemplo de carga útil JSON y un ejemplo de solicitud cURL.

Ejemplo de carga útil de solicitud

1
2
3
4

{
  "braze_id": "507f1f77bcf86cd799439011",
  "rel_kind": "account_user"
}

Ejemplo de solicitud cURL

Este ejemplo elimina la relación account_user entre el usuario especificado y acct-123. Tanto el perfil de usuario como el registro de cuenta se mantienen.

1
2
3
4
5
6
7

curl --location --request DELETE 'https://rest.iad-01.braze.com/data_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"
}'

Respuesta

Esta sección incluye un ejemplo de respuesta exitosa y los campos de respuesta.

Ejemplo de respuesta exitosa

El código de estado 200 podría devolver el siguiente cuerpo de respuesta.

1

{ "deleted": true }

Parámetros de respuesta

La siguiente tabla enumera y describe los campos de una respuesta exitosa.

Errores

La siguiente tabla enumera los errores comunes de este endpoint y cómo resolverlos.