links

POST /v1/content/campaigns

Schedule a run of articles across a window.

Tous les points de terminaison links

Toute la documentation pour développeurs

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 point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.

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/content/campaigns \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "brief": <string>, "posts": <integer> }'

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

Creates one queued article per topic, each targeting every site the campaign resolved to, each with its own moment inside the drip window. Gated on links.edit. Nothing is started by this call. The articles are queued as pending runs and a Temporal sweep starts each when its moment arrives — so the request path carries no long work, generation cost is spread across the window rather than paid upfront, and a campaign created during a Temporal outage is visible and simply starts late. Refused with 422 when the account is not in good standing: we do not spend money on an account that is not being paid for.

Paramètres

NomTypeObligatoireQu'est-ce que c'est
org_id (query)stringNonNarrow to one organisation. A reseller managing several client organisations reads the wrong one without it — and on a footprint-free network, another operator's posting schedule…

Corps de la requête

NomTypeObligatoireQu'est-ce que c'est
briefstringOuiThe standing instruction — voice, audience, what the sites are about.
postsintegerOuiHow many ARTICLES to write. Each is placed on every target site, so the number of publications is this times the site count.
topicsstring[]NonOne subject per article, so N articles are N articles rather than N paraphrases. A shorter list cycles; an empty one means the brief alone.
site_idsstring[]Non
site_group_idstringNonA site group, resolved when the campaign is created rather than copied. A recurring schedule pointed at a group re-resolves it on every firing, so sites added later are…
drip_daysintegerNonSpread the articles across this many days. 0 publishes them together.
drip_jitter_minutesintegerNonRandomise each moment by up to this many minutes either way. Perfectly even spacing is more detectable than posting all at once — nothing a person does is that regular — so this…
anchorsContentRunAnchor[]Non
categorystringNon
publish_policyContentRunPublishPolicyNonHow far a run may go on its own. draft_only is the default and puts nothing live.
recipe_idstringNon

Réponse

NomTypeObligatoireQu'est-ce que c'est
campaign_idstringOui
targetsContentCampaignTargetsOui
postsContentCampaignPlannedPost[]Oui
total_articlesintegerOuiArticles written. One per topic.
total_placementsintegerOuiIndividual publications — articles times sites. The number that reads as "how much am I about to do", and the one the spend estimate is built on.
first_atstringNon
last_atstringNon

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422