Excluir campanhas programadas disparadas pela API

Use esse endpoint para cancelar uma mensagem do canva que você programou anteriormente via API - disparada antes de ser enviada.

As mensagens programadas ou os disparos que forem excluídos muito perto ou durante o horário em que deveriam ser enviados serão atualizados com os melhores esforços, de modo que as exclusõ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 campaigns.trigger.schedule.delete.

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
{
  "campaign_id": (required, string) the campaign 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/campaigns/trigger/schedule/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "campaign_id": "campaign_identifier",
  "schedule_id": "schedule_identifier"
}'