Excluir telas programadas disparadas pela API

O ponto de extremidade de exclusão de agendamento permite cancelar uma mensagem que você agendou anteriormente por meio de Canvas disparados pela API antes que ela seja enviada.

As mensagens programadas ou os disparos que são excluídos perto ou durante o horário em que deveriam ser enviados são atualizados com os melhores esforços, de modo que o Braze pode aplicar exclusões de último segundo a todos, alguns ou nenhum de seus usuários direcionados.

Pré-requisitos

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

Limite de taxa

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
{
  "canvas_id": (required, string) the Canvas identifier,
  "schedule_id": (required, string) the `schedule_id` to delete (obtained from the response to create schedule)
}

Parâmetros de solicitação

Exemplo de solicitação

1
2
3
4
5
6
7
curl --location --request POST 'https://rest.iad-01.braze.com/canvas/trigger/schedule/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "canvas_id": "canvas_identifier",
  "schedule_id": "schedule_identifier"
}'