Atualizar telas programadas disparadas pela API

Use esse endpoint para atualizar as telas programadas disparadas pela API que foram criadas no dashboard.

Isso permite 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.

Note que, para enviar mensagens com esse ponto de extremidade, você deve ter um ID do Canvas, criado quando você constrói um Canvas.

Qualquer programação substituirá completamente a que você forneceu na solicitação de criação de programação ou em solicitações anteriores de atualização de programação.

• Por exemplo, se você originalmente forneceu "schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true} e, em sua atualização, forneceu "schedule" : {"time" : "2015-02-20T14:14:47"}, sua mensagem será enviada no horário fornecido 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, de modo que as alterações de último segundo poderão ser aplicadas a todos, alguns ou nenhum dos usuários direcionados.

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão canvas.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
{
  "canvas_id": (required, string) see Canvas 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/canvas/trigger/schedule/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "canvas_id": "canvas_identifier",
  "schedule_id": "schedule_identifier",
  "schedule": {
    "time": "2017-05-24T21:30:00Z",
    "in_local_time": true
  }
}'