Skip to content

Envie mensagens de campanha usando a entrega disparada por API

post

/campaigns/trigger/send

Use esse endpoint para enviar mensagens únicas e imediatas a usuários designados usando a entrega disparada pela API.

O envio disparado pela API permite que você abrigue o conteúdo da mensagem dentro do dashboard do Braze e, ao mesmo tempo, determine quando a mensagem será enviada e para quem, usando sua API.

Se estiver direcionando um segmento, um registro da sua solicitação será armazenado no console do desenvolvedor . Para enviar mensagens com esse endpoint, você deve ter um ID de campanha criado ao criar uma campanha disparada por API.

Pré-requisitos

Para usar esse endpoint, você precisará gerar uma chave de API com a permissão campaigns.trigger.send.

Limite de taxa

When specifying a segment or Connected Audience in your request, we apply a rate limit of 250 requests per minute to this endpoint. Otherwise, if specifying an external_id, this endpoint has a default rate limit of 250,000 requests per hour shared between /messages/send, /campaigns/trigger/send, and /canvas/trigger/send, as documented in API rate limits.

Braze endpoints support batching API requests. A single request to the messaging endpoints can reach any of the following:

  • Up to 50 specific external_ids, each with individual message parameters
  • A segment of any size created in the Braze dashboard, specified by its segment_id
  • An audience segment of any size, defined in the request as a connected audience object

Corpo da solicitação

Parâmetros de solicitação

Parâmetro Obrigatória Tipo de dados Descrição
campaign_id Obrigatória String Consulte identificador de campanha.
send_id Opcional String Consulte enviar identificador.
trigger_properties Opcional Objeto Consulte propriedades do disparador. Pares de valores-chave de personalização que serão aplicados a todos os usuários nessa solicitação.
broadcast Opcional Booleano Você deve definir broadcast como verdadeiro ao enviar uma mensagem para um segmento inteiro que uma campanha ou canva segmenta. 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 esta flag de forma não intencional pode fazer com que você envie sua mensagem para um público maior do que o esperado.
audience Opcional Objeto de público conectado Veja público conectado.
recipients Opcional Vetor Consulte objeto de destinatários.

Se send_to_existing_only for false, um objeto de atribuição deverá ser incluído.

Se recipients não for fornecido e broadcast for definido como true, a mensagem será enviada para todo o segmento de mensagens direcionado pela campanha.
attachments Opcional Vetor Se broadcast estiver definido como true, a lista attachments não poderá ser incluída.
  • O vetor de objetos pode conter até 50 objetos, sendo que cada objeto contém uma única string external_user_id e um objeto trigger_properties.
  • Quando send_to_existing_only for true, a Braze enviará a mensagem apenas para os usuários existentes. No entanto, esse sinalizador não pode ser usado com aliases de usuário.
  • Quando send_to_existing_only é false, uma atribuição precisa ser incluída. A Braze criará um usuário com o endereço id e as atribuições antes de enviar a mensagem.

O status do grupo de inscrições de um usuário pode ser atualizado com a inclusão de um parâmetro subscription_groups no objeto attributes. Para obter mais informações, consulte Objeto de atribuições do usuário.

Exemplo de solicitação

Detalhes da resposta

As respostas do endpoint de envio de mensagens incluirão o endereço dispatch_id da mensagem para referência ao envio da mensagem. O endereço dispatch_id é o ID do envio de mensagens, um ID exclusivo para cada transmissão enviada pela Braze. Ao usar esse endpoint, você recebe um único dispatch_id para um conjunto inteiro de usuários em lote. Para saber mais sobre o site dispatch_id, consulte nossa documentação sobre o comportamento do Dispatch ID.

Se sua solicitação encontrar um erro fatal, consulte Erros e respostas para obter o código e a descrição do erro.

Objeto de atribuições para campanhas

O Braze tem um objeto de envio de mensagens chamado attributes que lhe permitirá adicionar, criar ou atualizar atribuições e valores de um usuário antes de enviar a ele uma campanha disparada pela API. Usar o endpoint campaign/trigger/send como essa chamada de API processará o objeto de atribuições do usuário antes de processar e enviar a campanha. Isso ajuda a minimizar o risco de problemas causados por condições de corrida. No entanto, por padrão, os grupos de inscrições não podem ser atualizados dessa forma.

QUÃO ÚTIL FOI ESTA PÁGINA?
New Stuff!