Atualizar Campaigns agendadas disparadas por API

Use esse endpoint para atualizar Campaigns agendadas disparadas por API criadas no dashboard, permitindo que você decida qual ação deve disparar o envio da mensagem.

Você pode passar trigger_properties que a Braze usa como template na própria mensagem.

Observe que, para enviar mensagens com esse endpoint, você deve ter um ID de campanha, criado ao criar uma campanha disparada por API.

Qualquer cronograma sobrescreve completamente o que você forneceu na solicitação de criação de cronograma ou nas solicitações de atualização de cronograma anteriores. Por exemplo, se você originalmente definiu o cronograma como "schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true} e depois o atualizou para "schedule" : {"time" : "2015-02-20T14:14:47"}, a Braze envia a mensagem no horário especificado em UTC, não no fuso local do usuário.

Os disparos agendados que são atualizados perto ou durante o horário em que deveriam ser enviados são atualizados com o melhor esforço para que a Braze possa aplicar mudanças de última hora a todos, alguns ou nenhum dos seus usuários-alvo. As atualizações não são aplicadas se o cronograma original usou fuso local e o horário original já passou em qualquer fuso horário.

Pré-requisitos

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

Limite de frequência

Aplicamos o limite de frequência padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de frequência da API.

Corpo da solicitação

1
2
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY

1
2
3
4
5
6
7
{
  "campaign_id": (required, string) see campaign identifier,
  "schedule_id": (required, string) the `schedule_id` to update (obtained from the response to create schedule),
  "schedule": {
    // required, see create schedule documentation
  }
}

Parâmetros de solicitação

Exemplo de solicitação

1
2
3
4
5
6
7
8
9
10
11
curl --location --request POST 'https://rest.iad-01.braze.com/campaigns/trigger/schedule/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "campaign_id": "campaign_identifier",
  "schedule_id": "schedule_identifier",
  "schedule": {
    "time": "2017-05-24T21:30:00Z",
    "in_local_time": true
  }
}'