Skip to content
Ajuda
Guia do usuário
Guia do desenvolvedor
API
Parceiros de tecnologia
Novidades
EN
DE
ES
FR
JA
KO
PT-BR
EN
DE
ES
FR
JA
KO
PT-BR
API
Ajuda
Documentation
Guia do usuário
Guia do desenvolvedor
API
Parceiros de tecnologia
Novidades
braze.com
braze.com
Início
Endpoints
Catálogos
Gerenciamento de catálogo
Síncrono
DELETE: Excluir catálogo
OBTER: Listar catálogos
POST: Criar catálogo
Itens do catálogo
Assíncrono
DELETE: exclui vários itens do catálogo
PATCH: Editar vários itens do catálogo
POST: Criar vários itens de catálogo
PUT: Substituir vários itens do catálogo
Síncrono
DELETE: exclui item do catálogo
OBTER: Listar detalhes do item do catálogo
OBTER: Listar vários detalhes de itens do catálogo
PATCH: Editar item do catálogo
POST: Criar item de catálogo
PUT: Substituir item do catálogo
Campos do catálogo
Assíncrono
DELETE: Excluir campo de catálogo
POST: Criar campos de catálogo
Seleções do catálogo
Assíncrono
DELETE: Excluir seleção de catálogo
POST: Criar seleção de catálogo
Ingestão de dados em nuvem
OBTER: Integrações de listas
OBTER: Listar o status de sincronização do trabalho
POST: Sincronizar disparo
Listas e endereços de e-mail
OBTER: Consulta de e-mails hard bounce
OBTER: Consulta à lista de endereços de e-mail que cancelaram inscrição
POST: Alterar o status da inscrição de e-mail
POST: Remover e-mails com hard bounce
POST: Remover endereços de e-mail da lista de spam
POST: Envio de e-mails para listas de bloqueio
POST: Envio de e-mails para a lista de proibições
Exportar
Campanhas
OBTER: Exportar análises de dados da campanha
OBTER: Exportar detalhes da campanha
OBTER: Exportar lista de campanhas
OBTER: Exportar análises de envio
Canva
OBTER: Exportar análise de dados da série de dados da canva
OBTER: Exportar análises de resumo de dados do Canva
OBTER: Exportar detalhes do Canvas
OBTER: Exportar lista de canva
Eventos personalizados
OBTER: Exportar lista de eventos personalizados
OBTER: Exportar análises de dados de eventos personalizados
OBTER: Exportar eventos personalizados
KPIs
OBTER: Exportar novos usuários diários por data
OBTER: Exportar usuários ativos diários por data
OBTER: Exportar usuários ativos mensais dos últimos 30 dias
OBTER: Exporte KPIs para desinstalações diárias de apps por data
Compras
OBTER: Exportar IDs de produtos
OBTER: Dados de receita de exportação
OBTER: Número de compras de exportação
Segmentos
OBTER: Exportar lista de segmentos
OBTER: Detalhes do segmento de exportação
OBTER: Análise de dados do segmento de exportação
POST: Cancelar exportações por segmento
Sessões
OBTER: Exportar sessões do app por hora
Dados de usuários
POST: Exportar perfil de usuário por identificador
POST: Exportar perfil de usuário por segmento
POST: Exportar perfil de usuário pelo grupo de controle global
Atributos personalizados
OBTER: Exportar atributos personalizados
Biblioteca de mídia
Gerenciar ativos
POST: Fazer upload de um ativo para a biblioteca de mídia
Mensagens
Envio de mensagens duplicadas
POST: Campanhas duplicadas
POST: Canvas duplicadas
Atividade ao vivo
POST: Iniciar atividade ao vivo
POST: Atualizar atividade ao vivo
Envio de mensagens
OBTER: Liste as próximas campanhas e telas programadas
POST: Excluir envios de mensagens agendadas
POST: Excluir telas programadas disparadas pela API
POST: Excluir campanhas programadas disparadas pela API
POST: Criar envios de mensagens programadas
POST: Agende campanhas disparadas pela API
POST: Agendar canvas acionados por API
POST: Atualizar envios de mensagens programadas
POST: Atualizar campanhas programadas disparadas pela API
POST: Atualizar telas programadas disparadas pela API
Envio de mensagens
POST: Criar IDs de envio
POST: Envio imediato de mensagens usando apenas a API
POST: Envie e-mails de transação usando a entrega disparada por API
POST: Envie campanhas usando entrega acionada por API
POST: Envie mensagens do canva usando entrega acionada por API
Central de Preferências
OBTER: Gerar URL da Central de Preferências
OBTER: Listar centros de preferência
OBTER: Exibir detalhes da Central de Preferências
POST: Central de Preferências de e-mail
PUT: Atualizar a Central de Preferências
SCIM
DELETE: Remova a conta de usuário do dashboard
OBTER: Pesquise a conta de usuário existente do dashboard por e-mail
OBTER: Procure uma conta de usuário de dashboard existente
POST: Criar nova conta de usuário do dashboard
PUT: Atualizar a conta de usuário do dashboard
Autenticação do SDK
POST: Crie a chave de autenticação do SDK
OBTER: Listar chaves de autenticação do SDK
PUT: Defina a chave de autenticação do SDK primário
DELETE: Remover chave de autenticação do SDK
SMS
OBTER: Consulta de números telefônicos inválidos
POST: Remover números de telefone inválidos
Grupos de inscrições
OBTER: Listar o status do grupo de inscrições dos usuários
OBTER: Listar grupos de inscrições de usuários
POST: Atualizar o status do grupo de inscrições dos usuários
POST: Atualizar o status do grupo de inscrições dos usuários v2
Modelos
Modelos de blocos de conteúdo
OBTER: Listar blocos de conteúdo disponíveis
OBTER: Veja informações sobre Blocos de Conteúdo
POST: Criar bloco de conteúdo
POST: Atualizar bloco de conteúdo
Modelos de e-mail
OBTER: Lista de modelos de e-mail disponíveis
OBTER: Veja as informações do modelo de e-mail
POST: Criar modelo de e-mail
POST: Atualizar o modelo de e-mail
Traduções
Campanhas
OBTER: Ver todas as traduções de uma campanha
PUT: Atualizar tradução em uma campanha
OBTER: Veja os valores de origem padrão para as tags de tradução da campanha
Blocos de conteúdo
OBTER: Veja todas as traduções para um bloco de conteúdo
PUT: Atualizar tradução em um bloco de conteúdo
Canva
OBTER: Ver tradução para uma canva
PUT: Atualizar a tradução em uma tela
OBTER: Veja os valores de origem padrão para as tags de tradução do canva
Modelos de e-mail
OBTER: Ver traduções de origem para modelo de e-mail
OBTER: Ver tradução específica e local para o modelo de e-mail
OBTER: Veja todas as traduções e locais para o modelo de e-mail
PUT: Atualizar traduções para um e-mail modelo
Dados de usuários
POST: Criar novo alias de usuário
POST: Atualizar o alias do usuário
POST: Identificar usuários
POST: Criar e atualizar usuários
POST: Criar e atualizar usuários (síncrono)
POST: Excluir usuários
POST: Mesclar usuários
Migração de ID externo
POST: Renomear ID externo
POST: Remover ID externo
Objetos e filtros
Objeto de contexto do Canvas
Filtro e objeto do público conectado
Objeto de evento
Objeto de compra
Objeto destinatários
Aliases para identificar o objeto
Objeto de propriedades do disparador
Objeto de alias de usuário
Objeto de atribuições do usuário
Objeto de seleção de catálogo
Objeto de agendamento
Objetos de mensagens
objetos Android
Objeto da Apple
Objeto do cartão de conteúdo
Objeto de e-mail
Objeto push do Kindle e do FireOS
Objeto SMS
Objeto da Web
Objeto de webhook
Objeto do WhatsApp
Objetos e apêndice da API do SCIM
Visão geral da API
Tipos de identificadores da API
Erros e respostas
Retenção de dados
Postman e solicitações de amostra
Problemas de conectividade de rede da API
Limites de taxa
Casos de uso da API
Campanhas da API
Campanhas transacionais
STATUS DO SISTEMA BRAZE
Verificando o status do Braze
Endpoints da Biblioteca de Mídia
Use os endpoints da biblioteca de mídia do Braze para gerenciar ativos dentro do Braze.
Gerenciar Ativos
POST: Fazer upload de novo ativo por URL
New Stuff!
