Atualizar campanhas programadas disparadas pela API

Use esse endpoint para atualizar campanhas programadas acionadas por API criadas no dashboard, permitindo que você decida qual ação deve disparar a mensagem a ser enviada.

Você pode passar o endereço trigger_properties que será modelado na própria mensagem.

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

Qualquer programação substituirá completamente a que você forneceu na solicitação de criação de programação ou nas solicitações anteriores de atualização de programação. Por exemplo, se você definir originalmente o agendamento para "schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true} e depois atualizá-lo para "schedule" : {"time" : "2015-02-20T14:14:47"}, a mensagem será enviada no horário especificado em UTC, e não no fuso local do usuário.

Os disparos programados que forem atualizados muito perto ou durante o horário em que deveriam ser enviados serão atualizados com os melhores esforços para que as alterações de último segundo possam ser aplicadas a todos, alguns ou nenhum dos seus usuários direcionados. As atualizações não serão aplicadas se a programação original tiver usado o fuso local e a hora original já tiver passado 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 taxa

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

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
  }
}'