Esta página foi traduzida automaticamente e pode conter imprecisões. Para relatar um erro de tradução, use o componente de feedback na parte inferior do sumário, à direita da página.
Guia da API da Braze
A Braze oferece uma REST API de alto desempenho para rastrear usuários, enviar mensagens, exportar dados e gerenciar Campaigns, Canvas, catálogos e muito mais. Use este glossário para navegar pelos endpoints por tipo, abrir artigos de referência com detalhes de solicitação e resposta, e encontrar links para autenticação, limites de frequência e documentação de objetos.
Endpoint
Description
Atualize as credenciais de push de um único app.
Exclua um campo de um catálogo.
Crie vários campos em um catálogo.
Exclua vários itens do seu catálogo.
Edite vários itens do seu catálogo.
Crie vários itens no seu catálogo.
Substitua vários itens em um catálogo.
Exclua um item em um catálogo.
Liste um item de catálogo e seus detalhes.
Retorne vários itens de catálogo e seu conteúdo.
Edite um item em um catálogo.
Crie um item em um catálogo.
Substitua um item em um catálogo.
Exclua um catálogo.
Liste os catálogos de um espaço de trabalho.
Crie um catálogo.
Exclua uma seleção de catálogo.
Crie uma seleção em um catálogo.
Retorne uma lista das integrações existentes.
Retorne uma lista de status de sincronização.
Dispare uma sincronização para uma determinada integração.
Veja a referência completa de endpoints de Data Objects, incluindo tipos de objetos, objetos e endpoints de relacionamento.
Liste, crie, substitua, atualize e exclua relacionamentos entre objetos.
Crie, substitua ou exclua até 50 relacionamentos entre objetos em uma única solicitação.
Obtenha um objeto de dados, ou substitua, atualize e exclua-o.
Liste os objetos de dados de um tipo.
Crie, substitua ou exclua até 50 objetos de dados, de qualquer combinação de tipos, em uma única solicitação.
Obtenha um tipo de objeto de dados e sua definição de esquema.
Liste os tipos de objetos de dados no espaço de trabalho.
Liste os tipos de relacionamento de objeto de um tipo de objeto de dados.
Liste os tipos de relacionamento de usuário de um tipo de objeto de dados.
Liste os relacionamentos de usuário de um objeto de dados.
Crie, substitua, atualize e exclua relacionamentos entre usuários e objetos.
Crie, substitua ou exclua até 50 relacionamentos entre usuários e objetos em uma única solicitação.
Obtenha uma lista de endereços de e-mail que tiveram "hard bounce" nas suas mensagens de e-mail em um determinado período.
Retorne os e-mails que cancelaram a inscrição durante o período de
start_date a end_date.
Cancele a inscrição de um usuário no e-mail e marque-o como hard bounce.
Defina o estado de inscrição de e-mail dos seus usuários.
Remova endereços de e-mail da sua lista de bounce da Braze.
Remova endereços de e-mail da sua lista de SPAM da Braze.
Recupere uma série diária de várias estatísticas de uma Campaign ao longo do tempo.
Recupere informações relevantes sobre uma Campaign específica.
Exporte uma lista de Campaigns, cada uma com seu nome, identificador de API da Campaign, indicação se é uma Campaign de API e as tags associadas à Campaign.
Recupere uma série diária de várias estatísticas de um
send_id rastreado.
Exporte dados de séries temporais de um Canvas.
Exporte consolidações de dados de séries temporais de um Canvas, com um resumo conciso dos resultados do Canvas.
Exporte metadados sobre um Canvas, como o nome, a hora de criação, o status atual e muito mais.
Exporte uma lista de Canvas, incluindo o nome, o identificador de API do 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 registrados no seu app.
Recupere uma série do número de ocorrências de um evento personalizado no seu app em um período designado.
Exporte uma lista de eventos personalizados, incluindo o nome, a descrição, o status, as tags associadas e a inclusão em 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 únicos em cada data.
Recupere uma série diária do número total de usuários ativos únicos em uma janela contínua de 30 dias.
Recupere uma série diária do número total de desinstalações em cada data.
Retorne listas paginadas de IDs de produtos.
Retorne o número total de compras no seu app em um intervalo de tempo.
Retorne o total de dinheiro gasto no seu app em um intervalo de tempo.
Exporte uma lista de Segments, cada um com seu nome, identificador de API do Segment e indicação se tem o rastreamento de análise de dados ativado.
Recupere uma série diária do tamanho estimado de um Segment ao longo do tempo.
Recupere informações relevantes sobre um Segment.
Cancele exportações do ID de Segment fornecido.
Recupere uma série do número de sessões do seu app em um período designado.
Exporte 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 Segment.
Faça upload de um ativo para a biblioteca de mídia.
Atualize uma Live Activity do iOS.
Retorne uma lista JSON de informações sobre Campaigns agendadas e Canvas de entrada entre agora e um
end_time designado especificado na solicitação.
Cancele uma mensagem que você agendou anteriormente, antes que ela seja enviada.
Cancele uma mensagem de Canvas que você agendou anteriormente via disparo pela API, antes que seja enviada.
Cancele mensagens de Campaign disparadas pela API que você agendou anteriormente, antes que sejam enviadas.
Agende o envio de uma Campaign, um Canvas ou outra mensagem em um horário determinado.
Envie mensagens de Campaigns criadas no dashboard por meio de entrega disparada pela API.
Agende mensagens de Canvas por meio de entrega disparada pela API.
Atualize mensagens agendadas. Esse endpoint aceita atualizações do parâmetro
schedule, do parâmetro messages ou de ambos.
Atualize Campaigns agendadas e disparadas pela API criadas no dashboard.
Atualize Canvas agendados e disparados pela API que você criou no dashboard.
Crie IDs de envio para enviar mensagens e rastrear o desempenho das mensagens de forma programática, sem criar uma Campaign para cada envio.
Envie mensagens únicas e imediatas para usuários designados por meio da API da Braze.
Envie mensagens transacionais únicas e imediatas para um usuário designado.
Envie mensagens únicas e imediatas para usuários designados por meio de entrega disparada pela API.
Envie mensagens de Canvas por meio de entrega disparada pela API.
Crie uma URL para um centro de preferências.
Liste os centros de preferências disponíveis.
Veja os detalhes do seu centro de preferências, incluindo quando ele foi criado e atualizado.
Crie um centro de preferências para permitir que os usuários gerenciem suas preferências de notificação para Campaigns de e-mail.
Atualize um centro de preferências.
Exclua uma chave de autenticação do SDK do seu app.
Liste as chaves de autenticação do SDK do seu app.
Crie uma nova chave de autenticação do SDK para o seu app.
Defina uma chave de autenticação do SDK como a chave primária do seu app.
Obtenha uma lista de números de telefone que a Braze marcou como "inválidos" em um determinado período.
Remova números de telefone "inválidos" da lista de inválidos na Braze. Use isso para revalidar números de telefone depois que a Braze os marcar como inválidos.
Obtenha o estado de 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 de inscrição de até 50 usuários no dashboard da Braze.
Atualize em lote o estado de inscrição de até 50 usuários no dashboard da Braze.
Liste as informações dos seus Content Blocks existentes.
Consulte as informações do seu Content Block de e-mail existente.
Crie um Content Block de e-mail.
Atualize um Content Block de e-mail.
Obtenha uma lista dos modelos de e-mail disponíveis na sua conta da Braze.
Obtenha informações sobre seus modelos de e-mail.
Crie modelos de e-mail no dashboard da Braze.
Atualize modelos de e-mail no dashboard da Braze.
Veja as traduções de origem padrão de um modelo de webhook.
Veja as traduções de um modelo de webhook.
Atualize as traduções de um modelo de webhook.
Remova os IDs externos antigos e obsoletos dos seus usuários.
Renomeie os IDs externos dos seus usuários.
Verifique se a Braze terminou de processar um grupo de solicitações /users/track.
Adicione novos aliases de usuário para usuários identificados existentes ou crie novos usuários não identificados.
Exclua qualquer perfil de usuário especificando um identificador de usuário conhecido.
Identifique um usuário não identificado (somente alias).
Registre eventos personalizados e compras, e atualize atributos do perfil de usuário.
Atualize nomes de alias de usuário existentes para novos nomes de alias de usuário.
Mescle um perfil de usuário em outro usuário.
Exclua permanentemente um usuário do dashboard existente.
Procure uma conta de usuário do dashboard existente especificando o e-mail.
Procure uma conta de usuário do dashboard existente especificando o ID de recurso.
Crie uma nova conta de usuário do dashboard especificando e-mail, nome, sobrenome e permissões (para definir permissões no nível da empresa, do espaço de trabalho e da equipe).
Atualize uma conta de usuário do dashboard existente especificando e-mail, nome, sobrenome e permissões (para definir permissões no nível da empresa, do espaço de trabalho e da equipe).
New Stuff!