Envio imediato de mensagens usando apenas a API
Use esse endpoint para enviar mensagens imediatas a usuários designados usando a API da Braze.
Se você direcionar a mensagem a um Segment, um registro da sua solicitação será armazenado no Console de desenvolvedor.

Se a carga útil final renderizada for maior do que o tamanho máximo permitido pelo serviço correspondente, o envio não será bem-sucedido.

Ao usar este endpoint para Campaigns de API, o destinatário já deve existir na Braze para que a solicitação seja bem-sucedida. Isso se aplica ao especificar usuários nos parâmetros external_user_ids ou user_aliases.
Criar novos usuários com envios de API
Se você precisar criar um usuário como parte de um envio pela API, há duas opções:
Opção 1: Use /users/track e depois envie
Primeiro, crie o usuário com o endpoint /users/track e, em seguida, aguarde a propagação dos dados (geralmente, recomenda-se aguardar alguns minutos) antes de iniciar o envio somente pela API. Observe que a Braze não garante os tempos de processamento de dados em /users/track. Portanto, podem ocorrer condições de corrida se você não deixar tempo suficiente entre essas chamadas.
Opção 2: Use uma Campaign ou um Canvas disparado por API
Use um fluxo de trabalho de Campaign disparada por API ou de Canvas. Eles permitem criar um destinatário, caso ainda não exista um. Essa opção simplifica seus processos de backend, mas exige que você configure uma Campaign ou um Canvas no dashboard da Braze.
Pré-requisitos
Para usar esse endpoint, você precisará gerar uma chave de API com a permissão messages.send.
Limite de frequência
Ao usar filtros de Connected Audience em sua solicitação, esse endpoint tem um limite de frequência de 250 solicitações por minuto. Caso contrário, se você especificar um external_id, esse endpoint tem um limite de frequência padrão de 250.000 solicitações por hora, compartilhado entre os endpoints documentados em Limites de frequência da API.
Esse endpoint aceita solicitações de API em lote. Uma única solicitação pode incluir qualquer um dos seguintes itens:
- Até 50
external_user_ids - Um segmento de qualquer tamanho criado no dashboard da Braze, especificado por seu
segment_id - Uma Connected Audience de qualquer tamanho
Corpo da solicitação

Não se esqueça de incluir objetos de envio de mensagens no corpo da solicitação para concluir suas solicitações.
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
// You will need to include at least one of 'segment_id', 'external_user_ids', and 'audience'
// Including 'segment_id' will send to members of that segment
// Including 'external_user_ids' and/or 'user_aliases' will send to those users
// Including both will send to the provided users if they are in the segment
"broadcast": (optional, boolean) see broadcast -- defaults to false on 8/31/17, must be set to true if no external_user_ids or aliases are provided,
"external_user_ids": (optional, array of strings) see external user identifier,
"user_aliases": (optional, array of user alias object) see user alias,
"segment_id": (optional, string) see segment identifier,
"audience": (optional, connected audience object) see connected audience,
"campaign_id": (optional*, string) required if you wish to track campaign stats (for example, sends, clicks, bounces, etc). see campaign identifier,
"send_id": (optional, string) see send identifier,
"override_frequency_capping": (optional, bool) ignore frequency_capping for campaigns, defaults to false,
"ignore_workspace_quiet_hours": (optional, bool) send even when the send time falls in workspace quiet hours, defaults to false,
"recipient_subscription_state": (optional, string) use this to send messages to only users who have opted in ('opted_in'), only users who have subscribed or are opted in ('subscribed') or to all users, including unsubscribed users ('all'), the latter being useful for transactional email messaging. Defaults to 'subscribed',
"messages": {
"android_push": (optional, android push object),
"apple_push": (optional, apple push object),
"content_card": (optional, content card object),
"email": (optional, email object),
"kindle_push": (optional, kindle/fireOS push object),
"web_push": (optional, web push object),
"webhook": (optional, webhook object),
"whats_app": (optional, WhatsApp object),
"sms": (optional, SMS object)
}
}
Parâmetros de solicitação
| Parâmetro | Obrigatório | Tipo de dados | Descrição |
|---|---|---|---|
broadcast |
Opcional | Booleano | Você deve definir broadcast como true ao enviar uma mensagem para um Segment inteiro direcionado por uma Campaign ou um Canvas. O padrão desse parâmetro é false (a partir de 31 de agosto de 2017). Se broadcast estiver definido como true, uma lista recipients não poderá ser incluída. No entanto, tenha cuidado ao definir broadcast: true, pois definir essa flag sem querer pode fazer com que você envie sua mensagem para um público maior do que o esperado. |
external_user_ids |
Opcional | Matriz de strings | Consulte ID de usuário externo. |
user_aliases |
Opcional | Matriz de objetos de alias de usuário | Consulte o objeto de alias de usuário. |
segment_id |
Opcional | String | Consulte identificador de Segment. |
audience |
Opcional | Objeto de público conectado | Consulte público conectado. |
campaign_id |
Opcional* | String | Para saber mais, consulte o identificador de Campaign. Obrigatório para rastrear métricas da Campaign (como *Envios, Cliques ou Bounces) no dashboard da Braze, ou para ver eventos associados a essa mensagem na guia Histórico de mensagens do perfil de usuário. Sem um campaign_id, a Braze não incrementa as estatísticas de entregabilidade no dashboard. Os envios ainda aparecem no Registro de atividade de mensagens, mas não nas métricas de desempenho de e-mail no dashboard. |
send_id |
Opcional | String | Consulte identificador de envio. |
override_frequency_capping |
Opcional | Booleano | Ignora frequency_capping para Campaigns. O padrão é false. |
ignore_workspace_quiet_hours |
Opcional | Booleano | Envia a mensagem mesmo quando o horário de envio cai dentro do horário de silêncio do espaço de trabalho para o canal dela. O padrão é false. Um valor que não seja booleano retorna um erro 400. Campaigns de API agendadas não aceitam esse parâmetro no endpoint /messages/schedule/create. |
recipient_subscription_state |
Opcional | String | Use essa opção para enviar mensagens apenas para usuários que aceitaram receber mensagens (opted_in), apenas para usuários que fizeram a inscrição ou aceitaram receber mensagens (subscribed) ou para todos os usuários, inclusive os que cancelaram a inscrição (all). O uso de all é útil para envio de mensagens de e-mail de transação. O padrão é subscribed. |
messages |
Opcional | Objetos de envio de mensagens | Consulte os objetos de envio de mensagens disponíveis. |
Exemplo de solicitação
curl --location --request POST 'https://rest.iad-01.braze.com/messages/send' \
--data-raw '{
"broadcast": "false",
"external_user_ids": "external_user_identifiers",
"user_aliases": {
"alias_name": "example_name",
"alias_label": "example_label"
},
"segment_id": "segment_identifier",
"audience": {
"AND": [
{
"custom_attribute": {
"custom_attribute_name": "eye_color",
"comparison": "equals",
"value": "blue"
}
},
{
"custom_attribute": {
"custom_attribute_name": "favorite_foods",
"comparison": "includes_value",
"value": "pizza"
}
},
{
"OR": [
{
"custom_attribute": {
"custom_attribute_name": "last_purchase_time",
"comparison": "less_than_x_days_ago",
"value": 2
}
},
{
"push_subscription_status": {
"comparison": "is",
"value": "opted_in"
}
}
]
},
{
"email_subscription_status": {
"comparison": "is_not",
"value": "subscribed"
}
},
{
"last_used_app": {
"comparison": "after",
"value": "2019-07-22T13:17:55+0000"
}
}
]
},
"campaign_id": "campaign_identifier",
"send_id": "send_identifier",
"override_frequency_capping": "false",
"recipient_subscription_state": "all",
"messages": {
"android_push": "(optional, Android Push Object)",
"apple_push": "(optional, Apple Push Object)",
"content_card": "(optional, Content Card Object)",
"email": "(optional, Email Object)",
"kindle_push": "(optional, Kindle/FireOS Push Object)",
"web_push": "(optional, Web Push Object)"
}
}'
Detalhes da resposta
As respostas do endpoint de envio de mensagens incluem o dispatch_id da mensagem, que serve como referência ao despacho da mensagem. O dispatch_id é o ID do despacho da mensagem, ou seja, o ID exclusivo de cada “transmissão” enviada pela Braze. Para saber mais, consulte Comportamento do Dispatch ID.