Listings APIListings API
Anmelden
POST/api/v4/social/posts/cancel

Einen geplanten Beitrag stornieren

Storniert einen geplanten Social-Media-Beitrag vor seiner Veröffentlichung und lässt bereits veröffentlichte Beiträge unverändert.

Erfordert einen API-Schlüssel. Format des Headers und Schlüsselrotation finden Sie unter Authentifizierung.

Parameter

Body

NameTypErforderlichBeschreibung
inputobjecterforderlichWrapper object. The entire request body must be nested under `input`.
input.socialPostIdstringerforderlichUUID of the scheduled post to cancel.

Beispielanfrage

Body zum direkten Einfügen. Ersetzen Sie Platzhalter-IDs und -Werte durch Ihre eigenen.

Request body
{  "input": {    "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"  }}

Antworten

200The scheduled post was cancelled and will not publish.
Response
{  "data": {    "archiveScheduledPost": {      "success": true,      "error": null,      "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"    }  }}
200The post was not in a cancellable state, most often because it has already published. The status is still 200: read `success`.
Response
{  "data": {    "archiveScheduledPost": {      "success": false,      "error": {        "message": "SY90006: Post is not scheduled and cannot be cancelled",        "code": "SY90006",        "contextInfo": null      },      "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"    }  }}
401Unauthenticated, missing or invalid API key.
404No post with that ID on this account.

Storniert einen Beitrag, dessen Veröffentlichung noch aussteht. Der Beitrag wechselt zu ARCHIVED und wird aus der Veröffentlichungspipeline entfernt. Entwürfe können auf dieselbe Weise storniert werden; bereits veröffentlichte Beiträge hingegen nicht.

Anwendungsfall: Ein Kunde zieht eine Kampagne in letzter Minute zurück. Ihr Kalender zeigt einen geplanten Beitrag, der Kunde ändert seine Meinung, und Sie stornieren ihn über Ihre eigene Benutzeroberfläche. Übernehmen Sie den Wert für id des Beitrags direkt aus der Beitragsliste der Marke und rufen Sie diesen Endpunkt auf; die Zeile wechselt zu ARCHIVED und wird beim nächsten Lesen durch einen {"status":["SCHEDULED"]}-Filter nicht mehr erfasst.

Anwendungsfall: Aufräumen vor dem Trennen eines Kanals. Das Trennen einer Verbindung storniert die bereits dafür eingereihten Beiträge nicht – stattdessen schlagen sie zum Veröffentlichungszeitpunkt mit SY95045 fehl. Stornieren Sie zuerst die geplanten Beiträge und trennen Sie dann die Verbindung, damit dem Kunden keine Fehler angezeigt werden.

Hinweise.

  • Der Request-Body muss in ein input-Objekt eingebettet sein.
  • Prüfen Sie success, nicht den HTTP-Status. Bei einem bereits veröffentlichten oder bereits stornierten Beitrag wird HTTP 200 mit success: false zurückgegeben.
  • Dies ist kein Löschvorgang. Es wird nichts von einer Plattform entfernt. Ein bereits veröffentlichter Beitrag bleibt online, und dieser Aufruf meldet dafür lediglich success: false. Es gibt keinen Endpunkt, der die Veröffentlichung eines Social-Media-Beitrags rückgängig macht; das Entfernen erfolgt auf der Plattform selbst.
  • Die Stornierung gilt entweder für alle Kanäle des Beitrags oder für keinen. Es ist nicht möglich, einen geplanten Beitrag auf einer Plattform zu stornieren und ihn gleichzeitig auf einer anderen veröffentlichen zu lassen; erstellen Sie separate Beiträge, wenn Sie dies benötigen.
  • Der Beitrag lässt sich anschließend weiterhin mit GET /social/posts/{postId} lesen, wobei post.status den Wert ARCHIVED hat.

Schreibvorgang: nicht im Live-Konto ausgeführt. Die gezeigte Anfrage und Antwort wurden anhand des API-Schemas erstellt.

Request
curl -X POST 'https://listingsapi.com/api/v4/social/posts/cancel' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"    }  }'
Run in playground