Synup
Schlüssel erstellen
v1Ressourcen/Distribution/postContent-Paket importieren

Content-Paket importieren

Importiert ein Paket als Beitragsentwürfe. Nichts wird geplant oder veröffentlicht: Eine Person in Synup prüft, gibt frei und plant jeden Beitrag. Wird dieselbe externalId und Version der Kampagne oder derselbe Idempotency-Key erneut gesendet, kommt das erste Ergebnis zurück. Dieselbe Version mit anderem Inhalt liefert 409 version_conflict; senden Sie sie dann als version + 1.

post/api/v1/distribution/packages
distribution:write
Query-Parameter
Idempotency-Keystringoptional
Eine beliebige eindeutige Zeichenfolge pro logischem Import. Ein erneuter Versuch mit demselben Schlüssel liefert das erste Ergebnis.
clientIdstringoptional
Der Kunde, wenn der Body eine rohe text/markdown-Datei ist.
Anfragetext
clientIdstringerforderlich
Der Kunde, zu dem das Paket gehört.
manifestobjectoptional
Ein synup.distribution/v1-Manifest: die Kampagne, ihre Dateien (assets) und eine Variante pro Zielbeitrag.
schemastring (synup.distribution/v1)erforderlich
campaignobjecterforderlich
externalIdstringerforderlich
versionintegererforderlich
titlestringerforderlich
templatestringoptional
subjectstringoptional
canonicalUrlstringoptional
anchorVideoUrlstringoptional
customerReviewRequiredbooleanoptional
allowRawAssetsbooleanoptional
slackobjectoptional
teamIdstringoptional
channelIdstringoptional
threadTsstringoptional
assetsarray of objecterforderlich
idstringerforderlich
rolestring (video | image | cover | captions | document | raw)erforderlich
filenamestringerforderlich
mimestringerforderlich
bytesintegererforderlich
sha256stringerforderlich
widthintegeroptional
heightintegeroptional
durationSecnumberoptional
languagestringoptional
sourceobjectoptional
urlstringoptional
provenanceobjectoptional
attributionRequiredbooleanoptional
customerReviewRequiredbooleanoptional
variantsarray of objecterforderlich
keystringerforderlich
platformstring (facebook | instagram | linkedin | x | pinterest | threads | bluesky | mastodon | reddit | medium | substack | vimeo | dailymotion | youtube | tiktok)erforderlich
connectionIdstringoptional
formatstring (feed | video | reel | short | image | carousel | article | link | text)optional
textstringoptional
titlestringoptional
descriptionstringoptional
mediaarray of stringoptional
coverstringoptional
captionsstringoptional
firstCommentstringoptional
linkobjectoptional
urlstringoptional
utmobjectoptional
articleobjectoptional
titlestringoptional
subtitlestringoptional
htmlstringoptional
redditobjectoptional
subredditstringoptional
flairstringoptional
postTypestring (text | link | image | video)optional
tagsarray of stringoptional
videoobjectoptional
privacystringoptional
categorystringoptional
isForKidsbooleanoptional
playlistIdstringoptional
tiktokobjectoptional
disableCommentbooleanoptional
disableDuetbooleanoptional
disableStitchbooleanoptional
brandContentbooleanoptional
suggestedAtstringoptional
timezonestringoptional
customerReviewRequiredbooleanoptional
markdownstringoptional
Eine Series-Markdown-Datei, die anstelle von manifest gesendet wird.
fileNamestringoptional
Der Name der Markdown-Datei. Ein .md-Name kennzeichnet die Zeichenfolge als Markdown.
filesarray of objectoptional
Größe und sha256 jeder Datei, die das Markdown nennt, zugeordnet über den Dateinamen. Erforderlich, um eine Serie mit Dateien zu importieren; die Vorschau akzeptiert sie auch ohne.
filenamestringerforderlich
bytesintegererforderlich
sha256stringerforderlich
widthintegeroptional
heightintegeroptional
durationSecnumberoptional
urlstringoptional
Ein https-Link, von dem Synup die Datei abruft, statt dass Sie sie hochladen.
intoSeriesIdstringoptional
Importiert die Datei als nächste Version dieser bestehenden Serie.
Antwort
dataobjectoptional
campaignIdstringoptional
versionintegeroptional
statusstring (imported | unchanged)optional
itemsarray of objectoptional
kindstring (asset | variant)optional
refstringoptional
outcomestring (created | revised | unchanged | update_available | published_unchanged | skipped)optional
postIdstringoptional
assetIdstringoptional
messagesarray of stringoptional
pendingUploadsarray of objectoptional
assetIdstringoptional
refstringoptional
filenamestringoptional
bytesintegeroptional
mimestringoptional
pendingFetchesarray of stringoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
409Die Anfrage steht im Widerspruch zum aktuellen Zustand der Ressource — zum Beispiel beim Ändern der E-Mail-Adresse oder Telefonnummer eines Empfängers, dem bereits eine Nachricht gesendet wurde, oder bei einer Team-Einladung, die bereits akzeptiert wurde (oder noch nicht akzeptiert wurde).
422Die Markdown-Datei enthält Fehler, daher wurde nichts importiert. issues listet sie nach Zeile auf.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/distribution/packages
Ihr API-Schlüssel
Idempotency-Key
clientId
Anfragetext*
{
  "data": {
    "campaignId": "dcm_123",
    "version": 1,
    "status": "imported",
    "items": [
      {
        "kind": "asset",
        "ref": "short-1",
        "outcome": "created",
        "assetId": "das_123",
        "messages": []
      },
      {
        "kind": "asset",
        "ref": "short-1-cover",
        "outcome": "created",
        "assetId": "das_124",
        "messages": []
      },
      {
        "kind": "variant",
        "ref": "short-1-linkedin",
        "outcome": "created",
        "postId": "post_123",
        "messages": []
      }
    ],
    "pendingUploads": [
      {
        "assetId": "das_124",
        "ref": "short-1-cover",
        "filename": "short-1.jpg",
        "bytes": 34683,
        "mime": "image/jpeg"
      }
    ],
    "pendingFetches": [
      "das_123"
    ]
  }
}

Neu bei der Synup-API?