Atualizar Canvas programados disparados pela API

Use esse endpoint para atualizar Canvas programados disparados pela API que foram criados no dashboard.

Isso permite que você decida qual ação aciona o envio da mensagem. Você pode passar trigger_properties que a Braze insere como template na própria mensagem.

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

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

• Por exemplo, se você originalmente fornecer "schedule" : {"time" : "2015-02-20T13:14:47", "in_local_time" : true} e então na sua atualização fornecer "schedule" : {"time" : "2015-02-20T14:14:47"}, a Braze envia sua mensagem no horário fornecido em UTC, não no horário local do usuário.
• Os gatilhos agendados que você atualiza perto ou durante o horário em que deveriam ser enviados são atualizados com o melhor esforço, então a Braze pode aplicar mudanças de última hora a todos, alguns ou nenhum dos seus usuários-alvo.

Pré-requisitos

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

Limite de taxa

Aplicamos o limite de taxa padrão da Braze de 250.000 solicitações por hora a esse endpoint, conforme documentado em Limites de taxa 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
{
  "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
  }
}'