Ir para o conteúdo

Guia do usuário
Guia do desenvolvedor
API
Parceiros de tecnologia
Novidades

API

Documentation
Guia do usuário
Guia do desenvolvedor
API
Parceiros de tecnologia
Novidades

braze.com

Pressione a seta para baixo para abrir o menu de documentação sem expandir a barra lateral.

DELETE: Excluir catálogo

GET: Listar catálogos

POST: Criar catálogo

DELETE: Excluir 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

DELETE: excluir item do catálogo

GET: Listar detalhes do item do catálogo

GET: 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

DELETE: Excluir campo de catálogo

POST: Criar campos de catálogo

DELETE: Excluir seleção de catálogo

POST: Criar seleção de catálogo

POST: Atualizar credenciais de push

Ingestão de dados na nuvem

GET: Listar integrações

GET: Listar status de sincronização do trabalho

POST: Disparar sincronização

Listas e endereços de e-mail

GET: Consulta de e-mails hard bounce

GET: 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

GET: Exportar análise de dados de campaign

GET: Exportar análise de dados de envio

GET: Exportar detalhes da campanha

GET: Exportar lista de campanhas

GET: Exportar análise de dados resumidos do Canvas

GET: Exportar análise de séries de dados do Canvas

GET: Exportar detalhes do Canvas

GET: Exportar lista de Canvas

GET: Exportar análise de dados de eventos personalizados

GET: Exportar eventos personalizados

GET: Exportar lista de eventos personalizados

GET: Exportar KPIs de desinstalações diárias de apps por data

GET: Exportar novos usuários diários por data

GET: Exportar usuários ativos diários por data

GET: Exportar usuários ativos mensais dos últimos 30 dias

GET: Exportar IDs de produtos

GET: Exportar dados de receita

GET: Exportar número de compras

GET: Exportar lista de segmentos

GET: Exportar detalhes do segmento

GET: Exportar análise de dados do segmento

POST: Cancelar exportações por segmento

GET: Exportar sessões do app por tempo

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

GET: Exportar atributos personalizados

Biblioteca de mídia

POST: Fazer upload de um ativo para a biblioteca de mídia

PUT: Substituir um ativo na biblioteca de mídia

POST: Atualizar atividade ao vivo

POST: Iniciar atividade ao vivo

POST: Criar IDs de envio

POST: Enviar Campaigns usando entrega disparada por API

POST: Enviar e-mails de transação usando entrega disparada por API

POST: Enviar mensagens do Canvas usando entrega acionada por API

POST: Envio imediato de mensagens usando apenas a API

POST: Duplicar Campaigns

POST: Duplicar Canvas

GET: Listar próximas Campaigns e Canvas agendados

POST: Agendar Campaigns disparadas por API

POST: Agendar Canvas disparados por API

POST: Atualizar Campaigns agendadas disparadas por API

POST: Atualizar Canvas programados disparados pela API

POST: Atualizar mensagens agendadas

POST: Criar envios de mensagens programadas

POST: Excluir campanhas programadas disparadas pela API

POST: Excluir Canvas programados disparados pela API

POST: Excluir mensagens agendadas

Central de Preferências

GET: Gerar URL da Central de Preferências

GET: Listar Centrais de Preferências

GET: Ver informações da Central de Preferências

POST: Criar Central de Preferências

PUT: Atualizar a Central de Preferências

DELETE: Remover conta de usuário do dashboard

GET: Pesquisar conta de usuário existente do dashboard por e-mail

GET: Procurar 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: Criar chave de autenticação do SDK

GET: Listar chaves de autenticação do SDK

PUT: Definir a chave primária de autenticação do SDK

DELETE: Remover chave de autenticação do SDK

SMS

GET: Consulta de números de telefone inválidos

POST: Remover números de telefone inválidos

Grupos de inscrições

GET: Listar grupos de inscrições de usuários

GET: Listar o status do grupo de inscrições dos 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

GET: Listar Content Blocks disponíveis

GET: Ver informações sobre Content Blocks

POST: Atualizar bloco de conteúdo

POST: Criar bloco de conteúdo

GET: Listar modelos de e-mail disponíveis

GET: Ver informações do modelo de e-mail

POST: Atualizar modelo de e-mail

POST: Criar modelo de e-mail

Dados de usuários

POST: Criar novo alias de usuário

POST: Atualizar alias de usuário

POST: Identificar usuários

POST: Criar e atualizar usuários

POST: Criar e atualizar usuários (em massa)

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

GET: Ver valores de origem padrão para tags de tradução de bloco de conteúdo

GET: Ver todas as traduções de um bloco de conteúdo

PUT: Atualizar tradução em um bloco de conteúdo

GET: Ver todas as traduções de uma campanha

PUT: Atualizar tradução em uma campanha

GET: Ver valores de origem padrão para tags de tradução de campanha

GET: Ver tradução para um Canvas

PUT: Atualizar tradução em um Canvas

GET: Ver valores de origem padrão para tags de tradução do Canvas

GET: Ver traduções de origem para modelo de e-mail

GET: Ver tradução específica e local para modelo de e-mail

GET: Ver todas as traduções e locais para modelo de e-mail

PUT: Atualizar traduções para um modelo de e-mail

GET: Ver traduções de origem para modelo de webhook

GET: Ver traduções para modelo de webhook

PUT: Atualizar traduções para modelo de webhook

Objetos de dados

GET: Listar tipos de objetos de dados

GET: Obter tipo de objeto de dados

GET: Listar tipos de relacionamento de usuário

GET: Listar tipos de relacionamento de objetos

GET: Listar objetos de dados

GET: Obter objeto de dados

POST: Criar objeto de dados

PUT: Substituir objeto de dados

PATCH: Atualizar objeto de dados

DELETE: Excluir objeto de dados

GET: Listar relacionamentos de objetos

POST: Criar relacionamento de objeto

PUT: Substituir relacionamento de objeto

PATCH: Atualizar relacionamento de objeto

DELETE: Excluir relacionamento de objeto

GET: Listar relacionamentos de usuários

POST: Criar relacionamento de usuário

PUT: Substituir relacionamento de usuário

PATCH: Atualizar relacionamento de usuário

DELETE: Excluir relacionamento de usuário

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 alias de usuário

Objeto de atribuições do usuário

Objeto de propriedades do gatilho

Objeto de agendamento

Objeto de seleção de catálogo

Objetos Android

Objeto da Apple

Objeto do cartão de conteúdo

Objeto de e-mail

Objeto push do Kindle e do FireOS

Objeto de webhook

Objeto do WhatsApp

Objetos e apêndice da API SCIM

Visão geral da API

Tipos de identificadores da API

Erros e respostas

Retenção de dados

Dados de interação de mensagens

Postman e solicitações de amostra

Problemas de conectividade de rede da API

Limites de taxa

Casos de uso da API

Campanhas da API

Campaigns transacionais

Pressione Esc para fechar o menu

Endpoints de SMS

Use os endpoints de SMS da Braze para gerenciar os números de telefone dos seus usuários em seus grupos de inscrições.

GET: Consultar números de telefone inválidos
POST: Remover números de telefone inválidos

Documentação da plataforma de engajamento do cliente Braze.

Recursos

Braze Learning
Comunidade
Certificação
Alloys

Jurídico

Declaração de inovação
Retenção de dados
Proteção de dados
Documentação de conformidade

Empresa

Sobre
Carreiras
Blog
Contato

© 2026 Braze, Inc. Todos os direitos reservados.

Política de privacidade Termos

Verificando o status do Braze