POST/api/v4/social/connections/disconnect

Eine Verbindung trennen

Schaltet ein verbundenes Social-Media-Konto sofort offline; sein Platz im kontoweiten Pool bleibt bis zum Ende des Abrechnungszeitraums reserviert.

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.socialProfileConnectedChannelIdstringerforderlichUUID of the connection to remove, the `id` of a row from GET /social/brands/{brandId}/connections.

Beispielanfrage

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

Request body
{  "input": {    "socialProfileConnectedChannelId": "b81d5b3c-4a90-4f6a-9c11-71e0dd2fa4a7"  }}

Antworten

200Connection removed.
Response
{  "data": {    "disconnectSocialConnectedChannel": {      "success": true,      "error": null    }  }}
200The connection could not be removed, most often because it belongs to a different brand (`SY95052`) or has already been disconnected. The status is still 200: read `success`.
Response
{  "data": {    "disconnectSocialConnectedChannel": {      "success": false,      "error": {        "message": "SY95052: Connected channel does not belong to this brand",        "code": "SY95052",        "contextInfo": null      }    }  }}
401Unauthenticated, missing or invalid API key.

Entfernt ein verbundenes Social-Media-Konto aus seiner Marke. Die Marke wird nicht direkt angesprochen: Die Verbindungs-ID identifiziert beide. Dieser Vorgang ist endgültig, ohne Zeitfenster zum Abbrechen und ohne Möglichkeit zum Rückgängigmachen. Um den Kanal wiederherzustellen, erstellen Sie einen neuen Verbindungslink und lassen Sie den Benutzer die Autorisierung erneut erteilen.

Anwendungsfall: Ein Kunde widerruft den Zugriff auf einen Kanal. Wenn ein Kunde Ihnen die Kontrolle über eine Seite entzieht, trennen Sie diesen Kanal, damit geplante Beiträge nicht mehr versuchen, dort zu veröffentlichen. Lesen Sie die id aus den Verbindungen der Marke aus, trennen Sie die Verbindung und lesen Sie anschließend die Liste erneut ab, um dies zu bestätigen.

Hinweise.

  • Der Request-Body muss in ein input-Objekt eingebettet sein. Das Feld heißt socialProfileConnectedChannelId — die eigene UUID der Verbindung, nicht die connectedAccountId der Plattform und nicht die Marken-ID.
  • Prüfen Sie success, nicht den HTTP-Status. Bei einer Verbindung, die zu einer anderen Marke gehört oder bereits entfernt wurde, wird HTTP 200 mit success: false zurückgegeben. Die Payload enthält keine ID. Halten Sie daher selbst fest, welche Verbindung Sie zum Entfernen angegeben haben.
  • Achten Sie auf die leicht zu verwechselnden Namen. Dieses Feld im Body heißt socialProfileConnectedChannelId, mit Profile in der Mitte. Der benachbarte Insights-Endpunkt erwartet socialConnectedChannelId — dieselbe ID, aber ein Wort kürzer. Die Namen unterscheiden sich um ein Wort, und keiner der beiden Endpunkte akzeptiert den Feldnamen des anderen.
  • Geplante Beiträge werden nicht storniert. Ein Beitrag, dessen Veröffentlichung auf diesem Kanal geplant war, schlägt zum Veröffentlichungszeitpunkt mit SY95045 fehl, anstatt verworfen zu werden. Stornieren Sie ihn zuerst mit POST /social/posts/cancel, wenn Sie diesen Fehler vermeiden möchten.
  • Bereits veröffentlichte Beiträge bleiben online. Durch das Trennen verliert listingsAPI die Möglichkeit, Beiträge zu veröffentlichen und Insights abzurufen; es wird nichts von der Plattform gelöscht.
  • Der Platz kehrt bei der Verlängerung in den Pool zurück, nicht bei erfolgreichem Aufruf. GET /social/limits zeigt dies sofort durch einen niedrigeren Wert für usage.connectionsActive und einen höheren Wert für usage.connectionsReleased an, während usage.connections — die abrechnungsrelevante Anzahl, auf die die Obergrenze angewendet wird — bis zum Wechsel des Abrechnungszeitraums unverändert bleibt. usage.connectionsReleased gibt an, wie viel Kapazität bei der Verlängerung wieder verfügbar wird. Siehe Tarife und Add-ons.
  • Dasselbe Konto erneut mit derselben Marke zu verknüpfen, ist kostenlos. Wenn Sie ein Social-Media-Konto erneut verbinden, das Sie zuvor im selben Zeitraum von dieser Marke getrennt haben, wird sein vorhandener Platz wiederverwendet: Es wechselt aus connectionsReleased zurück in connectionsActive, und der abrechnungsrelevante Wert connections ändert sich nicht. Ein Platz wird für jede Kombination aus Marke und Konto reserviert, sodass ein anderes Social-Media-Konto einen neuen Platz benötigt, ebenso wie dasselbe Konto bei einer anderen Marke.
  • Das Archivieren einer Marke trennt alle zugehörigen Verbindungen, sodass Sie diesen Aufruf vor dem Archivieren nicht ausführen müssen. Auch dabei bleiben die Plätze bis zum Ende des Zeitraums reserviert — auf welchem Weg die Verbindung getrennt wird, macht keinen Unterschied.

Schreibvorgang: nicht für das 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/connections/disconnect' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "socialProfileConnectedChannelId": "b81d5b3c-4a90-4f6a-9c11-71e0dd2fa4a7"    }  }'