Esta página fue traducida automáticamente y puede contener errores. Para informar de un error de traducción, usa el componente de comentarios situado bajo el sumario, a la derecha de la página.
Guía de la API de Braze
Braze ofrece una REST API de alto rendimiento que te permite rastrear usuarios, enviar mensajes, exportar datos y más. Esta página enumera los endpoints disponibles de la API de Braze y sus usos.
Endpoint
Description
Actualiza las credenciales push de una sola aplicación.
Elimina un campo de un catálogo.
Crea varios campos en un catálogo.
Elimina varios elementos de tu catálogo.
Edita varios elementos de tu catálogo.
Crea varios elementos en tu catálogo.
Reemplaza varios elementos en un catálogo.
Elimina un elemento de un catálogo.
Lista un elemento del catálogo y sus detalles.
Devuelve varios elementos del catálogo y su contenido.
Edita un elemento de un catálogo.
Crea un elemento en un catálogo.
Reemplaza un elemento en un catálogo.
Elimina un catálogo.
Lista los catálogos de un espacio de trabajo.
Crea un catálogo.
Elimina una selección del catálogo.
Crea una selección en un catálogo.
Devuelve una lista de las integraciones existentes.
Devuelve una lista de estados de sincronización.
Activa una sincronización para una integración determinada.
Obtiene una lista de las direcciones de correo electrónico que han tenido un "rebote duro" en tus mensajes de correo electrónico en un plazo determinado.
Devuelve los correos electrónicos que cancelaron su suscripción durante el periodo de tiempo de
start_date a end_date.
Cancela la suscripción de un usuario de correo electrónico y lo marca como rebote duro.
Establece el estado de suscripción de correo electrónico para tus usuarios.
Elimina direcciones de correo electrónico de tu lista de rebotes de Braze.
Elimina direcciones de correo electrónico de tu lista de correo no deseado de Braze.
Recupera una serie diaria de diversas estadísticas de una Campaign a lo largo del tiempo.
Recupera información relevante sobre una Campaign especificada.
Exporta una lista de Campaigns, cada una de las cuales incluye su nombre, el identificador de API de la Campaign, si se trata de una Campaign de API y las etiquetas asociadas a la Campaign.
Recupera una serie diaria de diversas estadísticas de un
send_id con seguimiento.
Exporta datos de series temporales para un Canvas.
Exporta resúmenes acumulados de datos de series temporales para un Canvas, proporcionando un resumen conciso de los resultados de un Canvas.
Exporta metadatos sobre un Canvas, como el nombre, la hora de creación, el estado actual y más.
Exporta una lista de Canvas, incluido el nombre, el identificador de API del Canvas y las etiquetas asociadas.
Exporta una lista de atributos personalizados que incluye el nombre, la descripción, el tipo de datos, la longitud de la matriz (si corresponde), el estado y las etiquetas asociadas.
Exporta una lista con los nombres de los eventos personalizados registrados para tu aplicación.
Recupera una serie del número de ocurrencias de un evento personalizado en tu aplicación durante un periodo de tiempo determinado.
Exporta una lista de eventos personalizados que incluye el nombre, la descripción, el estado, las etiquetas asociadas y la inclusión en informes de análisis.
Recupera una serie diaria del número total de nuevos usuarios en cada fecha.
Recupera una serie diaria del número total de usuarios activos únicos en cada fecha.
Recupera una serie diaria del número total de usuarios activos únicos durante una ventana móvil de 30 días.
Recupera una serie diaria del número total de desinstalaciones en cada fecha.
Devuelve una lista paginada de ID de productos.
Devuelve el número total de compras en tu aplicación durante un intervalo de tiempo.
Devuelve el dinero total gastado en tu aplicación durante un intervalo de tiempo.
Exporta una lista de Segments, cada uno de los cuales incluye su nombre, el identificador de API del Segment y si tiene habilitado el seguimiento de análisis.
Recupera una serie diaria del tamaño estimado de un Segment a lo largo del tiempo.
Recupera información relevante sobre un Segment.
Cancela las exportaciones para el ID de Segment proporcionado.
Recupera una serie del número de sesiones de tu aplicación durante un periodo de tiempo determinado.
Exporta todos los usuarios de un grupo de control global.
Exporta datos de cualquier perfil de usuario especificando un identificador de usuario.
Exporta todos los usuarios de un Segment.
Sube un activo a la biblioteca de medios.
Actualiza una Live Activity de iOS.
Devuelve una lista JSON con información sobre Campaigns programadas y Canvas de entrada entre el momento actual y el
end_time especificado en la solicitud.
Cancela un mensaje programado previamente antes de que se haya enviado.
Cancela un mensaje de Canvas que hayas programado previamente mediante entrega desencadenada por API antes de que se haya enviado.
Cancela mensajes de Campaign desencadenados por API que hayas programado previamente antes de que se hayan enviado.
Programa una Campaign, un Canvas u otro mensaje para que se envíe a una hora determinada.
Envía mensajes de Campaign creados en el panel mediante entrega desencadenada por API.
Programa mensajes de Canvas mediante entrega desencadenada por API.
Actualiza los mensajes programados. Este endpoint acepta actualizaciones del parámetro
schedule o messages, o ambos.
Actualiza Campaigns programadas desencadenadas por API creadas en el panel.
Actualiza Canvas programados desencadenados por API que creaste en el panel.
Crea ID de envío para enviar mensajes y realizar el seguimiento del rendimiento de los mensajes de forma programática, sin necesidad de crear una Campaign para cada envío.
Envía mensajes inmediatos y puntuales a usuarios designados a través de la API de Braze.
Envía mensajes transaccionales inmediatos y puntuales a un usuario designado.
Envía mensajes inmediatos y puntuales a usuarios designados mediante entrega desencadenada por API.
Envía mensajes de Canvas mediante entrega desencadenada por API.
Crea una URL para un centro de preferencias.
Lista los centros de preferencias disponibles.
Consulta los detalles de tu centro de preferencias, incluyendo cuándo se creó y actualizó.
Crea un centro de preferencias que permita a los usuarios gestionar sus preferencias de notificación para Campaigns de correo electrónico.
Actualiza un centro de preferencias.
Elimina una clave de autenticación SDK para tu aplicación.
Lista las claves de autenticación SDK para tu aplicación.
Crea una nueva clave de autenticación SDK para tu aplicación.
Establece una clave de autenticación SDK como clave principal para tu aplicación.
Obtiene una lista de números de teléfono que Braze ha marcado como "no válidos" en un periodo de tiempo determinado.
Elimina números de teléfono "no válidos" de la lista de no válidos en Braze. Usa esto para volver a validar los números de teléfono después de que Braze los haya marcado como no válidos.
Obtiene el estado de suscripción de un usuario en un grupo de suscripción.
Lista y obtiene los grupos de suscripción de un determinado usuario.
Actualiza por lotes el estado de suscripción de hasta 50 usuarios en el panel de Braze.
Actualiza por lotes el estado de suscripción de hasta 50 usuarios en el panel de Braze.
Lista la información de tus Content Blocks existentes.
Consulta información de tu Content Block de correo electrónico existente.
Crea un Content Block de correo electrónico.
Actualiza un Content Block de correo electrónico.
Obtiene una lista de las plantillas de correo electrónico disponibles en tu cuenta de Braze.
Obtiene información sobre tus plantillas de correo electrónico.
Crea plantillas de correo electrónico en el panel de Braze.
Actualiza plantillas de correo electrónico en el panel de Braze.
Elimina los antiguos ID externos obsoletos de tus usuarios.
Cambia el nombre de los ID externos de tus usuarios.
Añade nuevos alias de usuario para usuarios identificados existentes o para crear nuevos usuarios no identificados.
Elimina cualquier perfil de usuario especificando un identificador de usuario conocido.
Identifica a un usuario no identificado (solo alias).
Registra eventos personalizados, compras y actualiza los atributos del perfil de usuario.
Actualiza los nombres de alias de usuario existentes a nuevos nombres de alias de usuario.
Fusiona un perfil de usuario con otro usuario.
Elimina de forma permanente un usuario existente del panel.
Busca una cuenta de usuario existente en el panel especificando su dirección de correo electrónico.
Busca una cuenta de usuario existente en el panel especificando su ID de recurso.
Crea una nueva cuenta de usuario del panel especificando correo electrónico, nombre y apellidos, y permisos (para establecer permisos a nivel de empresa, espacio de trabajo y equipo).
Actualiza una cuenta de usuario existente en el panel especificando correo electrónico, nombre y apellidos, y permisos (para establecer permisos a nivel de empresa, espacio de trabajo y equipo).
New Stuff!