Ir al contenido

Eliminar relación de objetos

delete

/data_objects/objects/{type_name}/{external_id}/object_relationships

Usa este endpoint para eliminar una arista de relación de objeto a objeto.

Requisitos previos

Para usar este endpoint, necesitas una clave de API con el permiso data_objects.object_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}/object_relationships.

Parámetro Obligatorio Tipo de datos Descripción
type_name Obligatorio String Tipo de objeto en la URL
external_id Obligatorio String Identificador de objeto en la URL

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}/object_relationships.

Parámetro Obligatorio Tipo de datos Descripción
rel_kind Obligatorio String Tipo de relación
related_type_name Obligatorio String Tipo de objeto relacionado
related_external_id Obligatorio String Identificador de objeto relacionado
anchor Opcional String source (predeterminado) o target

Ejemplo de solicitud

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

Carga útil de solicitud de ejemplo

{
  "rel_kind": "subaccount",
  "related_type_name": "account",
  "related_external_id": "acct-456",
  "anchor": "source"
}

Solicitud cURL de ejemplo

Este ejemplo elimina la relación subaccount entre acct-123 y acct-456. Ambos registros de cuenta permanecen.

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_external_id": "acct-456",
  "anchor": "source"
}'

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.

{ "deleted": true }

Parámetros de respuesta

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

Parámetro Obligatorio Tipo de datos Descripción
deleted Obligatorio Booleano 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 Error de validación Confirma que el cuerpo de la solicitud incluya valores válidos para rel_kind, related_type_name, related_external_id y anchor.
404 Relación u objeto del endpoint no encontrado Confirma que ambos objetos existan y que los valores de la clave de relación coincidan con una arista existente.
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 permiso o la solicitud está bloqueada por la lista de permitidos Confirma que la clave tenga el permiso data_objects.object_relationships.delete y que tu IP de origen esté en la lista de permitidos de la clave, si está configurada.
429 Límite de velocidad excedido Reintenta después de X-RateLimit-Reset y reduce la frecuencia de solicitudes.
New Stuff!