links
POST /v1/content/campaigns/{campaignId}/pause
Hold every article that has not started.
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.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
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/content/campaigns/{campaignId}/pause \
-H "Authorization: Bearer zdk_live_…"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
Holds every queued article. Acts only on articles that have not started — one already being written has been paid for, and one already published is on a customer's site, so pausing cannot mean un-publishing and must not appear to. affected is how many were actually held, so a screen can say "paused 8 of 12" rather than reporting a silent success the customer's own queue contradicts. Gated on links.edit.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
campaignId (path) | string | Oui | — |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
affected | integer | Oui | How many articles the action actually touched. A campaign of twelve with four already written reports 8 for a pause, so a screen can say "paused 8 of 12" rather than a silent… |
campaign | ContentCampaign | Oui | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 422