Skip to content

Agende campanhas disparadas pela API

post

/campaigns/trigger/schedule/create

Use esse endpoint para enviar mensagens de campanha criadas no painel por meio de entrega acionada pela API, permitindo que você decida qual ação deve disparar o envio da mensagem.

Você pode passartrigger_properties, que se tornará um modelo na própria mensagem.

Observe que, para enviar mensagens com esse endpoint, é necessário ter um ID de campanha, criado quando você cria uma campanha disparada pela API.

Pré-requisitos

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

Limite de taxa

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, 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 Ver identificador de campanha
send_id Opcional String Consulte enviar identificador.
recipients Opcional Matriz de objetos de destinatários Veja objetos de destinatários.
audience Opcional Objeto de público conectado Veja público conectado.
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.
trigger_properties Opcional Objeto Pares de valores-chave de personalização para todos os usuários nesse envio. Consulte propriedades de gatilho.
schedule Obrigatória Objeto de agendamento Veja objeto de agendamento.

Exemplo de solicitação

Resposta

Exemplo de resposta bem-sucedida

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