Campaigns
POST /v1/campaigns/{campaignId}/control
Pause, resume or cancel a running send.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Où insérer l'ID de votre organisation
Cet endpoint prend org_id comme champ dans le corps JSON.
L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X POST https://api.zinndigital.com/v1/campaigns/{campaignId}/control \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "action": <string<pause, resume, cancel>> }'Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
The decision is written to the database first and signalled second, so a worker that restarted and never saw the signal still stops on its next batch.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
campaignId (path) | string | Oui | — |
Corps de la requête
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
action | string<pause, resume, cancel> | Oui | — |
org_id | string | Non | — |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | string | Oui | — |
org_id | string | Oui | — |
name | string | Oui | — |
template_id | string | Oui | — |
segment_id | string | Non | — |
purpose | string<marketing, transactional> | Oui | — |
channels | string[] | Oui | — |
status | string<draft, scheduled, sending, paused, sent, cancelled, failed> | Oui | — |
scheduled_for | string | Non | — |
include_not_in_good_standing | boolean | Non | — |
total_recipients | integer | Oui | — |
skipped | CampaignSkipCounts | Oui | ⛔ Every skip counted separately and never silent, and **every one is present even when it is zero**. "4,127 recipients, 312 skipped — not in good standing" is rendered from thes… |
delivery | CampaignDeliveryCounts | Non | ⛔ `sent` is NOT `delivered`. `sent` means a provider accepted the hand-off; `delivered` means the receiving server accepted it, which arrives later by webhook. A screen showing… |
last_error | string | Non | — |
created_at | string | Oui | — |
started_at | string | Non | — |
finished_at | string | Non | — |
signal_delivered | boolean | Non | ⛔ Reported honestly. `false` means the decision is recorded and the running workflow was not reachable — it will still stop on its next batch, but that is a real difference an o… |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422