Braze API Guide
Braze provides a high-performance REST API to allow you to track users, send messages, export data, and more. This page lists available Braze API endpoints and their uses.
Endpoint
Description
Borrar un campo de un catálogo.
Crear 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.
Sustituye varios elementos de un catálogo.
Eliminar un elemento de un catálogo.
Enumerar un artículo del catálogo y sus detalles.
Devuelve varios elementos del catálogo y su contenido.
Editar un elemento de un catálogo.
Crear un elemento en un catálogo.
Sustituye un elemento de un catálogo.
Borrar un catálogo.
Enumera los catálogos de un espacio de trabajo.
Crear un catálogo.
Borrar una selección del catálogo.
Crear una selección en un catálogo.
Devuelve una lista de las integraciones existentes.
Devuelve una lista de estados de sincronización.
Activar una sincronización para una integración determinada.
Obtén una lista de las direcciones de correo electrónico que se consideraron "rebotes duros" y rebotaron tus mensajes de correo electrónico en un plazo determinado.
Devuelve los correos electrónicos que se han dado de baja durante el periodo de tiempo de
start_date a end_date.
Dar de baja a un usuario de correo electrónico y marcarlo como rebote duro.
Establezca el estado de suscripción de correo electrónico para sus usuarios.
Elimine direcciones de correo electrónico de su lista de rebotes Braze.
Elimine direcciones de correo electrónico de su lista de spam Braze.
Recuperar una serie diaria de diversas estadísticas de una campaña a lo largo del tiempo.
Recuperar información relevante sobre una campaña especificada.
Exporte una lista de campañas, cada una de las cuales incluirá su nombre, el identificador API de la campaña, si se trata de una campaña API y las etiquetas asociadas a la campaña.
Recuperar una serie diaria de diversas estadísticas de un seguimiento
send_id.
Exportar datos de series temporales para un lienzo.
Exportar rollups de datos de series temporales para un lienzo, proporcionando un resumen conciso de los resultados de un lienzo.
Exporte metadatos sobre un lienzo, como el nombre, la hora de creación, el estado actual, etc.
Exporte una lista de lienzos, incluido el nombre, el identificador de API de lienzo y las etiquetas asociadas.
Exporte una lista de atributos personalizados que incluya el nombre, la descripción, el tipo de datos, la longitud de la matriz (si procede), el estado y las etiquetas asociadas.
Exportar una lista de nombres de eventos personalizados que se han registrado para su aplicación.
Recupera una serie del número de ocurrencias de un evento personalizado en tu aplicación durante un periodo de tiempo designado.
Exporte una lista de eventos personalizados que incluya el nombre, la descripción, el estado, las etiquetas asociadas y la inclusión de informes analíticos.
Recuperar una serie diaria del número total de nuevos usuarios en cada fecha.
Recuperar una serie diaria del número total de usuarios activos únicos en cada fecha.
Recuperar 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.
Recuperar una serie diaria de estadísticas de participación de una tarjeta a lo largo del tiempo.
Recuperar información relevante sobre una tarjeta.
Exportar una lista de tarjetas de noticias, cada una de las cuales incluirá su nombre y el identificador API de la tarjeta.
Devuelve una lista paginada de IDs 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.
Exporte una lista de segmentos, cada uno de los cuales incluirá su nombre, el identificador de la API del segmento y si tiene activado el seguimiento analítico.
Recupera una serie diaria del tamaño estimado de un segmento a lo largo del tiempo.
Recuperar información relevante sobre un segmento.
Recupera una serie del número de sesiones de tu aplicación durante un periodo de tiempo determinado.
Exportar todos los usuarios de un Grupo de Control Global.
Exporte datos de cualquier perfil de usuario especificando un identificador de usuario.
Exportar todos los usuarios de un segmento.
Actualizar una actividad de iOS Live.
Devuelve una lista JSON con información sobre las campañas programadas y los lienzos de entrada entre el momento actual y el momento designado.
end_time especificado en la solicitud.
Cancelar un mensaje programado previamente antes de que se haya enviado.
Cancela un mensaje de Canvas que hayas programado antes mediante entrega desencadenada por API antes de que se haya enviado.
Cancele los mensajes de campaña activados por la API que haya programado previamente antes de que se hayan enviado.
Programe una campaña, Canvas u otro mensaje para que se envíe a una hora determinada.
Envía mensajes de campaña creados en el panel mediante entrega desencadenada por API.
Programa mensajes de Canvas mediante entrega desencadenada por API.
Actualizar los mensajes programados. Este punto final acepta actualizaciones del parámetro
schedule o messages o ambos.
Actualice las campañas programadas activadas por API creadas en el panel de control.
Actualice los lienzos programados activados por la API que se crearon en el panel de control.
Cree ID de envío que puedan utilizarse para enviar mensajes y realizar un seguimiento del rendimiento de los mensajes mediante programación, sin necesidad de crear campañas para cada envío.
Envía mensajes inmediatos y puntuales a usuarios designados a través de la API Braze.
Envía inmediatamente mensajes transaccionales puntuales a un usuario designado.
Envíe mensajes inmediatos y puntuales a usuarios designados a través de la entrega activada por API. - Enviar mensajes
Envíe mensajes Canvas a través de la entrega activada por API. - Enviar mensajes
Crear una URL para un centro de preferencias.
Lista de centros de preferencia disponibles.
Vea los detalles de sus centros de preferencias, incluida la fecha de creación y actualización.
Cree un centro de preferencias que permita a los usuarios gestionar sus preferencias de notificación para las campañas de correo electrónico.
Actualizar un centro de preferencias.
Obtenga una lista de los números de teléfono que se han considerado "no válidos" en un plazo determinado.
Eliminar números de teléfono "inválidos" de la lista de inválidos en Braze. Se puede utilizar para volver a validar números de teléfono después de que se hayan marcado como no válidos.
Obtener el estado de suscripción de un usuario en un grupo de suscripción.
Listar y obtener los grupos de suscripción de un determinado usuario.
Actualice por lotes el estado de suscripción de hasta 50 usuarios en el panel Braze.
Actualice por lotes el estado de suscripción de hasta 50 usuarios en el panel Braze.
Enumere la información de los bloques de contenido existentes.
Información de llamada para su Bloque de contenido de correo electrónico existente.
Crear un bloque de contenido de correo electrónico.
Actualizar un bloque de contenido de correo electrónico.
Obtenga una lista de las plantillas de correo electrónico disponibles en su cuenta Braze.
Obtenga información sobre sus plantillas de correo electrónico.
Cree plantillas de correo electrónico en el panel Braze.
Actualice las plantillas de correo electrónico en el panel Braze.
Elimine los antiguos ID externos obsoletos de sus usuarios.
Cambie el nombre de los identificadores externos de sus usuarios.
Añadir 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.
Identificar a un usuario no identificado (solo alias).
Registre eventos personalizados, compras y actualice los atributos del perfil del usuario.
Actualice los nombres de alias de usuario existentes a nuevos nombres de alias de usuario.
Fusionar un perfil de usuario con otro usuario.
Elimina de forma permanente a 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.
Cree una nueva cuenta de usuario del cuadro de mandos especificando el correo electrónico, los nombres y apellidos y los permisos (para establecer permisos a nivel de empresa, espacio de trabajo y equipo).
Actualice una cuenta de usuario existente en el cuadro de mandos especificando el correo electrónico, los nombres y apellidos, y los permisos (para establecer permisos a nivel de empresa, espacio de trabajo y equipo).
Editar esta página en GitHub
¿QUÉ TAN ÚTIL FUE ESTA PÁGINA?
New Stuff!