Eine Marke archivieren

Name	Typ	Erforderlich	Beschreibung
input	object	erforderlich	Wrapper object. The entire request body must be nested under `input`.
input.socialProfileId	string	erforderlich	UUID of the brand to archive. Same value as the `brandId` path token used elsewhere.

Archiviert eine Marke. Die Archivierung erfolgt sofort: Sobald die Marke seit mindestens 90 Tagen zum Konto gehört, archiviert dieser Aufruf sie und alle mit ihr verbundenen Social-Media-Konten in derselben Anfrage, und diese Konten stellen die Veröffentlichung umgehend ein.

Anwendungsfall: Kapazität für den nächsten Abrechnungszeitraum planen. Die Anzahl der Marken selbst ist unbegrenzt und wird nicht für die Abrechnung erfasst, daher geht es bei der Archivierung nicht um die Markenanzahl, sondern um Verbindungen. Wenn ein Kunde abgewandert ist, schaltet die Archivierung seiner Marke dessen Kanäle noch heute offline und merkt die Freigabe ihrer Plätze für die Verlängerung vor; genau das gibt usage.connectionsReleased in GET /social/limits an. Wenn Sie die Kapazität vorher benötigen, kaufen Sie ein Verbindungspaket – das ist die einzige Änderung, die sofort wirksam wird.

Statuswerte in der Antwort:

ARCHIVED: Die Marke und ihre Verbindungen sind archiviert. Dies ist das einzige erfolgreiche Ergebnis.
TENURE_NOT_MET: Die Marke ist jünger als 90 Tage und kann noch nicht archiviert werden. success ist false, error.code ist SY95051, und die Marke bleibt unverändert.

Hinweise.

Der Anfragetext muss in ein input-Objekt eingebettet sein, und das Feld heißt socialProfileId, nicht brandId.
Prüfen Sie success, nicht den HTTP-Status. Wenn die Mindestdauer nicht erfüllt ist, wird ein HTTP 200 mit success: false, status: "TENURE_NOT_MET" und SY95051 in error zurückgegeben.
Eine Marke muss mindestens 90 Tage alt sein, um archiviert werden zu können. Für Standorte gilt dieselbe Regel; siehe Tarife und Zusatzpakete. Versuchen Sie es nach dem 90. Tag der Marke erneut; diese Regel lässt sich über die API nicht außer Kraft setzen.
Wenn Sie eine Marke archivieren, werden auch ihre Verbindungen archiviert. Jedes mit der Marke verknüpfte Social-Media-Konto wird im selben Vorgang getrennt, und GET /social/limits zeigt dies beim nächsten Abruf durch einen niedrigeren Wert für usage.connectionsActive und einen höheren Wert für usage.connectionsReleased an. Der abrechnungsrelevante Wert usage.connections bleibt bis zum Beginn des nächsten Zeitraums unverändert.
Bei der Marke gibt es nichts zu stornieren. Die Archivierung selbst wartet nicht auf das Ende eines Abrechnungszeitraums, daher gibt es dafür weder einen vorgemerkten Zustand noch einen Aufruf zum Stornieren. Aufgeschoben wird jedoch die Auswirkung auf die Abrechnung: Die freigegebenen Verbindungsplätze werden wie bei einem gekündigten Zusatzpaket erst am Ende des Abrechnungszeitraums wieder verfügbar.

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

Antworten

200Brand archived. Its connections are archived with it and go offline at once, but their slots stay counted against `maxConnections` until the billing period ends.

Response

{  "data": {    "archiveSocialProfile": {      "success": true,      "error": null,      "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",      "status": "ARCHIVED"    }  }}

200The brand is less than 90 days old and cannot be archived yet. `success` is `false` and `status` is `TENURE_NOT_MET`.

{  "data": {    "archiveSocialProfile": {      "success": false,      "error": {        "message": "SY95051: Brand must be at least 90 days old before it can be archived",        "code": "SY95051",        "contextInfo": null      },      "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",      "status": "TENURE_NOT_MET"    }  }}

401Unauthenticated, missing or invalid API key.

404No brand with that ID on this account (`SY95043`).

Parameter

Body

Beispielanfrage

Antworten