Archivia un brand

Nome	Tipo	Obbligatorio	Descrizione
input	object	obbligatorio	Wrapper object. The entire request body must be nested under `input`.
input.socialProfileId	string	obbligatorio	UUID of the brand to archive. Same value as the `brandId` path token used elsewhere.

Archivia un brand. L'archiviazione è immediata: una volta che il brand è presente nell'account da almeno 90 giorni, questa chiamata archivia il brand e tutti gli account social ad esso connessi nella stessa richiesta, e tali account smettono subito di pubblicare.

Caso d'uso: pianificare la capacità del ciclo successivo. I brand sono illimitati e non vengono conteggiati ai fini dell'utilizzo, quindi l'archiviazione non riguarda il numero di brand, ma le connessioni. Se un cliente ha interrotto il rapporto, archiviare il suo brand ne disattiva i canali oggi e fa sì che i relativi slot tornino disponibili al rinnovo, come indicato da usage.connectionsReleased in GET /social/limits. Se ti serve capacità prima di allora, acquista un pacchetto di connessioni: è l'unica modifica che ha effetto immediato.

Valori di stato nella risposta:

ARCHIVED: il brand e le relative connessioni sono archiviati. Questo è l'unico esito positivo.
TENURE_NOT_MET: il brand ha meno di 90 giorni e non può ancora essere archiviato. success è false, error.code è SY95051 e il brand rimane invariato.

Note.

Il corpo della richiesta deve essere racchiuso in un oggetto input e il campo è socialProfileId, non brandId.
Controlla success, non lo stato HTTP. Il mancato rispetto del requisito di permanenza produce un HTTP 200 con success: false, status: "TENURE_NOT_MET" e SY95051 in error.
Un brand deve avere almeno 90 giorni per poter essere archiviato. È la stessa regola a cui sono soggette le sedi; vedi Piani e componenti aggiuntivi. Riprova dopo il 90° giorno del brand; non è possibile derogare a questa regola tramite l'API.
L'archiviazione di un brand ne archivia le connessioni. Tutti gli account social collegati al brand vengono disconnessi nella stessa operazione e GET /social/limits riflette questa modifica alla lettura successiva con un valore di usage.connectionsActive più basso e un valore di usage.connectionsReleased più alto. Il valore fatturabile di usage.connections rimane invariato fino all'inizio del periodo successivo.
Non c'è nulla da annullare sul brand. L'archiviazione stessa non attende la fine di un ciclo di fatturazione, quindi non esistono uno stato programmato né una chiamata per annullarla. Ciò che viene rinviato è l'effetto sulla fatturazione: gli slot delle connessioni rilasciate, come quelli di un pacchetto aggiuntivo disdetto, tornano disponibili alla chiusura del ciclo.

Operazione di scrittura: non eseguita sull'account reale. La richiesta e la risposta mostrate sono costruite a partire dallo schema dell'API.

Risposte

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`).

Parametri

Corpo

Richiesta di esempio

Risposte