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
Excluir um campo de um catálogo.
Criar vários campos em um catálogo.
Excluir vários itens em seu catálogo.
Edite vários itens em seu catálogo.
Crie vários itens em seu catálogo.
Retorna vários itens de catálogo e seu conteúdo.
Atualizar vários itens em um catálogo.
Excluir um item em um catálogo.
Listar um item de catálogo e seus detalhes.
Editar um item em um catálogo.
Criar um item em um catálogo.
Atualizar um item em um catálogo.
Excluir um catálogo.
Listar os catálogos em um espaço de trabalho.
Criar um catálogo.
Excluir uma seleção de catálogo.
Criar uma seleção em um catálogo.
Retorna uma lista de integrações existentes.
Retorna uma lista de status de sincronização.
Disparar uma sincronização para uma determinada integração.
Obtenha uma lista de endereços de e-mail que tenham "hard bounce" suas mensagens de e-mail em um determinado período de tempo.
Retornar e-mails que cancelaram inscrição durante o período de
start_date para end_date.
Cancelar inscrição de um usuário no e-mail e marcá-lo como hard bounce.
Defina o estado da inscrição de e-mail para seus usuários.
Remova endereços de e-mail de sua lista de bounce da Braze.
Remova endereços de e-mail de sua lista de spam do Braze.
Recupere uma série diária de várias estatísticas de uma campanha ao longo do tempo.
Recupere informações relevantes sobre uma campanha específica.
Exporte uma lista de campanhas, cada uma das quais incluirá seu nome, o identificador da API da campanha, se é uma campanha de API e as tags associadas à campanha.
Recupere uma série diária de várias estatísticas para um rastreamento
send_id.
Exportar dados de séries temporais para um Canva.
Exporte rollups de dados de séries temporais para um canva, fornecendo um resumo conciso dos resultados de um canva.
Exporte metadados sobre um canva, como o nome, a hora de criação, o status atual e muito mais.
Exporte uma lista de canvas, incluindo o nome, o identificador da API dos canvas e as tags associadas.
Exporte uma lista de atributos personalizados, incluindo o nome, a descrição, o tipo de dados, o comprimento da matriz (se aplicável), o status e as tags associadas.
Exporte uma lista de nomes de eventos personalizados que foram registrados para o seu aplicativo.
Recupere uma série do número de ocorrências de um evento personalizado em seu app durante um período de tempo designado.
Exporte uma lista de eventos personalizados, incluindo o nome, a descrição, o status, as tags associadas e a inclusão de relatórios de análise de dados.
Recupere uma série diária do número total de novos usuários em cada data.
Recupere uma série diária do número total de usuários ativos exclusivos em cada data.
Recupere uma série diária do número total de usuários ativos diários exclusivos em uma janela contínua de 30 dias.
Recupera uma série diária do número total de desinstalações em cada data.
Recupere uma série diária de estatísticas de engajamento de um cartão ao longo do tempo.
Recupere informações relevantes em um cartão.
Exporte uma lista de cartões do Feed de notícias, cada um dos quais incluirá seu nome e o identificador da API do cartão.
Retorna uma lista paginada de IDs de produtos.
Retorna o número total de compras em seu app em um intervalo de tempo.
Retorna o total de dinheiro gasto em seu app em um intervalo de tempo.
Exporte uma lista de segmentos, cada um dos quais incluirá seu nome, o identificador da API do segmento e se tem a análise de dados ativada.
Recupera uma série diária do tamanho estimado de um segmento ao longo do tempo.
Recupere informações relevantes sobre um segmento.
Recupere uma série do número de sessões do seu app em um período de tempo designado.
Exportar todos os usuários de um Grupo de Controle Global.
Exporte dados de qualquer perfil de usuário especificando um identificador de usuário.
Exporte todos os usuários de um segmento.
Atualizar uma atividade do iOS Live.
Retorna uma lista JSON de informações sobre campanhas agendadas e canvas de entrada entre agora e um período designado
end_time especificado na solicitação.
Cancelar uma mensagem que você programou anteriormente antes de ela ter sido enviada.
Cancelar uma mensagem do canva que você programou anteriormente via API - disparada antes de ser enviada.
Cancelar mensagens de campanha de mensagens disparadas pela API que você programou anteriormente antes de serem enviadas.
Programe o envio de uma campanha, canva ou outra mensagem em um horário determinado.
Envie mensagens de campanha criadas no dashboard por meio de entrega disparada por API.
Programe o envio de mensagens do canva por meio da entrega disparada pela API.
Atualizar envios de mensagens programadas. Esse ponto de extremidade aceita atualizações para o
schedule ou messages ou ambos.
Atualizar campanhas programadas disparadas por API criadas no dashboard.
Atualize os canvas programadas disparados pela API que foram criados no dashboard.
Crie IDs de envio que possam ser usados para enviar mensagens e rastrear o desempenho das mensagens de forma programática, sem a criação de campanhas para cada envio.
Envie mensagens únicas e imediatas para usuários designados por meio da API do Braze.
Envie mensagens transacionais únicas e imediatas para um usuário designado.
Envie mensagens únicas e imediatas para usuários designados por meio da entrega disparada pela API. - Envio de mensagens
Envie mensagens de canva por meio de entrega disparada por API. - Envio de mensagens
Crie um URL para uma Central de Preferências.
Liste os centros de preferências disponíveis.
Veja os detalhes de suas Centrais de Preferências, inclusive quando foram criadas e atualizadas.
Crie uma central de Preferências para permitir que os usuários gerenciem suas preferências de notificação para campanhas de e-mail.
Atualizar uma Central de Preferências.
Obtenha uma lista de números de telefone que foram considerados "inválidos" em um determinado período de tempo.
Remover números de telefone "inválidos" da lista de inválidos no Braze. Isso pode ser usado para revalidar números de telefone depois de terem sido marcados como inválidos.
Obtenha o estado da inscrição de um usuário em um grupo de inscrições.
Liste e obtenha os grupos de inscrições de um determinado usuário.
Atualize em lote o estado da inscrição de até 50 usuários no dashboard da Braze.
Atualize em lote o estado da inscrição de até 50 usuários no dashboard da Braze.
Liste suas informações de blocos de conteúdo existentes.
Informações de chamada para seu bloco de conteúdo de e-mail existente.
Crie um bloco de conteúdo de e-mail.
Atualizar um bloco de conteúdo de e-mail.
Obtenha uma lista dos modelos de e-mail disponíveis em sua conta Braze.
Obtenha informações sobre seus modelos de e-mail.
Crie modelos de e-mail no dashboard do Braze.
Atualize os modelos de e-mail no dashboard do Braze.
Remova as IDs externas antigas e obsoletas de seus usuários.
Renomeie as IDs externas de seus usuários.
Adicione novos aliases de usuário para usuários identificados existentes ou para criar novos usuários não identificados.
Exclua qualquer perfil de usuário especificando um identificador de usuário conhecido.
Identificar um usuário não identificado (somente alias).
Registre eventos personalizados, compras e atualize os atributos do perfil do usuário.
Atualize os nomes de alias de usuário existentes para novos nomes de alias de usuário.
Mesclar um perfil de usuário em outro usuário.
Procure uma conta de usuário existente no dashboard especificando seu e-mail.
Procure uma conta de usuário existente no dashboard especificando seu e-mail.
Atualize uma conta de usuário do dashboard existente especificando e-mail, nomes e sobrenomes, permissões (para definir permissões no nível da empresa, do espaço de trabalho e da equipe).
Exclua permanentemente um usuário do dashboard existente.
Crie uma nova conta de usuário do dashboard especificando e-mail, nome e sobrenome, permissões (para definir permissões no nível da empresa, do espaço de trabalho e da equipe).
Editar esta página no GitHub
QUÃO ÚTIL FOI ESTA PÁGINA?
New Stuff!