POST/api/v4/social/connections/disconnect

Disconnetti una connessione

Porta subito offline un account social connesso; il suo slot nel pool condiviso dell'account resta riservato fino a fine periodo di fatturazione.

Richiede una chiave API. Consulta Autenticazione per il formato dell’header e la rotazione delle chiavi.

Parametri

Corpo

NomeTipoObbligatorioDescrizione
inputobjectobbligatorioWrapper object. The entire request body must be nested under `input`.
input.socialProfileConnectedChannelIdstringobbligatorioUUID of the connection to remove, the `id` of a row from GET /social/brands/{brandId}/connections.

Richiesta di esempio

Corpo pronto da incollare. Sostituisci gli ID e i valori segnaposto con i tuoi.

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

Risposte

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.

Rimuove un account social connesso dal suo brand. Il brand non viene specificato direttamente: l'ID della connessione identifica entrambi. È un'operazione irreversibile, senza una finestra di annullamento né possibilità di ripristino. Per ripristinare il canale, genera un nuovo link di connessione e chiedi all'utente di autorizzare nuovamente l'accesso.

Caso d'uso: un cliente revoca l'accesso a un canale. Quando un cliente rimuove una Pagina dalla tua gestione, disconnetti quel canale in modo che i post programmati smettano di tentare la pubblicazione su di esso. Leggi id dall'elenco delle connessioni del brand, disconnetti la connessione, quindi rileggi l'elenco per confermare.

Note.

  • Il corpo della richiesta deve essere racchiuso in un oggetto input. Il campo è socialProfileConnectedChannelId: l'UUID della connessione stessa, non il valore connectedAccountId della piattaforma né l'ID del brand.
  • Controlla success, non lo stato HTTP. Una connessione che appartiene a un brand diverso o che non esiste più restituisce HTTP 200 con success: false. Il payload non contiene alcun ID, quindi conserva una tua registrazione della connessione che hai chiesto di rimuovere.
  • Fai attenzione ai nomi simili. Questo campo del corpo è socialProfileConnectedChannelId, con Profile al centro. L'endpoint degli insight adiacente accetta socialConnectedChannelId: lo stesso ID, con una parola in meno nel nome. I due nomi differiscono di una sola parola e nessuno dei due endpoint accetta il nome usato dall'altro.
  • I post programmati non vengono annullati. Un post programmato per questo canale non verrà eliminato, ma la sua pubblicazione non riuscirà e restituirà SY95045 al momento previsto. Annullalo prima con POST /social/posts/cancel se vuoi evitare l'errore.
  • I post già pubblicati rimangono online. La disconnessione rimuove la possibilità per listingsAPI di pubblicare e leggere gli insight; non elimina nulla dalla piattaforma.
  • Lo slot torna nel pool al rinnovo, non quando l'operazione riesce. GET /social/limits lo mostra immediatamente con un valore usage.connectionsActive inferiore e un valore usage.connectionsReleased superiore, mentre usage.connections, il numero fatturabile a cui si applica il limite, rimane invariato fino all'inizio del periodo di fatturazione successivo. usage.connectionsReleased indica quanta capacità torna disponibile al rinnovo. Consulta Piani e componenti aggiuntivi.
  • Ricollegare lo stesso account allo stesso brand è gratuito. Riconnettere un account social che hai disconnesso da quel brand in precedenza nello stesso periodo riutilizza lo slot esistente: lo slot passa da connectionsReleased a connectionsActive e il valore fatturabile connections non cambia. Uno slot viene riservato per ogni coppia brand-account, quindi un account social diverso richiede un nuovo slot, così come lo stesso account su un brand diverso.
  • L'archiviazione di un brand disconnette tutte le sue connessioni, quindi non devi effettuare prima questa chiamata quando procedi con l'archiviazione. Anche in quel caso gli slot rimangono riservati fino alla fine del periodo: il modo in cui vengono rilasciati non fa differenza.

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

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"    }  }'