Supprimer des campagnes planifiées déclenchées par API

Utilisez cet endpoint pour annuler un message Canvas que vous avez précédemment planifié via l’API avant qu’il ne soit envoyé.

Les messages planifiés ou les déclencheurs supprimés peu avant ou pendant leur heure d’envoi prévue sont mis à jour au mieux. Il est donc possible que Braze applique des suppressions de dernière seconde à la totalité, à une partie ou à aucun de vos utilisateurs ciblés.

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation campaigns.trigger.schedule.delete.

Limite de débit

La limite de débit par défaut de Braze de 250 000 requêtes par heure s’applique à cet endpoint, comme documenté dans Limites de débit de l’API.

Corps de la demande

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

Paramètres de demande

Exemple de demande

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