Ir al contenido

Eliminar relación de usuario

delete

/data_objects/objects/{type_name}/{object_id}/users

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

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 1000 solicitudes por minuto.

Parámetros de ruta

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

Parámetro Obligatorio Tipo de datos Descripción
type_name Obligatorio Cadena Tipo de objeto
object_id Obligatorio Cadena Identificador del objeto

Parámetros de solicitud

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

Parámetro Obligatorio Tipo de datos Descripción
user Obligatorio Objeto El usuario que se relacionará con el objeto. Debe contener exactamente uno de los siguientes: external_id, braze_id, alias, email o phone.
user.external_id Opcional Cadena El ID externo del usuario.
user.braze_id Opcional Cadena El ID de usuario de Braze.
user.alias Opcional Objeto Objeto de alias de usuario con alias_name y alias_label (ambos obligatorios cuando se usa).
user.email Opcional Cadena La dirección de correo electrónico del usuario.
user.phone Opcional Cadena El número de teléfono del usuario. Debe poder convertirse al formato E.164.
rel_kind Obligatorio Cadena Tipo de relación

Identificar al usuario

  • Pasa exactamente un identificador en user. Si no hay ningún identificador no nulo o hay más de uno, se devuelve 400. Se aceptan campos de identificador nulos junto a un identificador válido.
  • Si un correo electrónico o número de teléfono coincide con más de un perfil de usuario, Braze elige el usuario identificado (el que tiene un external_id). Si aún hay un empate, Braze elige el perfil actualizado más recientemente.
  • Usa external_id cuando esté disponible.

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

{
  "user": {
    "external_id": "user-123"
  },
  "rel_kind": "account_user"
}

Ejemplo alternativo con alias de usuario:

{
  "user": {
    "alias": {
      "alias_name": "[email protected]",
      "alias_label": "crm_email"
    }
  },
  "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 la cuenta se conservan.

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 '{
  "user": {
    "external_id": "user-123"
  },
  "rel_kind": "account_user"
}'

Respuesta

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

Ejemplo de respuesta correcta

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

{ "deleted": true }

Parámetros de respuesta

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

Parámetro Obligatorio Tipo de datos Descripción
deleted Obligatorio Booleano Indica si la eliminación de la relación se realizó correctamente

Errores

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

Estado Causa Orientación
400 Falta user o está vacío, no hay identificador, hay más de un identificador, hay un identificador en blanco, braze_id, email o alias tienen un formato incorrecto, el teléfono no se puede convertir a E.164, o se usa el antiguo cuerpo con braze_id de nivel superior Envía un objeto user con exactamente un identificador válido.
400 rel_kind desconocido para el tipo Confirma que rel_kind sea válido para el tipo de objeto.
404 Relación, objeto o usuario no encontrado (user-not-found) Confirma que existan el objeto, el usuario y los valores de la clave de relación.
401 Clave de API REST ausente o no válida Verifica que el encabezado Authorization use Bearer YOUR_REST_API_KEY y que la clave esté activa.
403 La clave de API no tiene el permiso necesario o la lista de permitidos bloquea la solicitud Confirma que la clave tenga el permiso data_objects.user_relationships.delete y que tu IP de origen esté en la lista de permitidos de la clave, si la configuraste.
429 Se superó el límite de velocidad Vuelve a intentarlo después de X-RateLimit-Reset y reduce la frecuencia de las solicitudes.
New Stuff!