POST/api/v4/social/connections/disconnect

Déconnecter une connexion

Met immédiatement hors ligne un compte social connecté ; sa place dans le pool du compte reste réservée jusqu’à la fin de la période de facturation.

Nécessite une clé API. Consultez Authentification pour le format de l’en-tête et la rotation des clés.

Paramètres

Corps

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

Exemple de requête

Corps prêt à coller. Remplacez les identifiants et valeurs d’exemple par les vôtres.

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

Réponses

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.

Retire un compte social connecté de sa marque. La marque n'est pas ciblée directement : l'ID de connexion identifie à la fois la connexion et la marque. Cette opération est irréversible, sans délai d'annulation ni possibilité de retour en arrière. Pour rétablir le canal, générez un nouveau lien de connexion et demandez à l'utilisateur d'accorder à nouveau son autorisation.

Cas d'utilisation : un client révoque l'accès à un canal. Lorsqu'un client vous retire le contrôle d'une Page, déconnectez ce canal pour que les publications programmées cessent de tenter d'y être publiées. Récupérez le id dans les connexions de la marque, déconnectez le canal, puis consultez à nouveau la liste pour confirmer.

Remarques.

  • Le corps de la requête doit être encapsulé dans un objet input. Le champ est socialProfileConnectedChannelId : il s'agit de l'UUID propre à la connexion, et non du connectedAccountId de la plateforme ni de l'ID de la marque.
  • Vérifiez success, et non le statut HTTP. Pour une connexion qui appartient à une autre marque ou qui n'existe plus, l'appel renvoie HTTP 200 avec success: false. Le contenu de la réponse ne comporte aucun ID ; conservez donc votre propre trace de la connexion dont vous avez demandé la suppression.
  • Attention aux noms très proches. Ce champ du corps de la requête est socialProfileConnectedChannelId, avec Profile au milieu. Le point de terminaison voisin consacré aux statistiques accepte socialConnectedChannelId : le même ID, avec un mot de moins. Leurs noms diffèrent d'un seul mot, et aucun des deux n'accepte le nom de l'autre.
  • Les publications programmées ne sont pas annulées. Une publication programmée sur ce canal échouera au moment de sa publication avec SY95045 au lieu d'être supprimée. Annulez-la d'abord avec POST /social/posts/cancel si vous souhaitez éviter cet échec.
  • Les publications déjà en ligne le restent. La déconnexion retire à listingsAPI la possibilité de publier et de consulter les statistiques ; elle ne supprime rien de la plateforme.
  • L'emplacement retourne dans le pool au renouvellement, et non lorsque l'appel réussit. GET /social/limits le reflète immédiatement par une baisse de usage.connectionsActive et une hausse de usage.connectionsReleased, tandis que usage.connections — le nombre facturable auquel s'applique le plafond — reste inchangé jusqu'au début de la période de facturation suivante. usage.connectionsReleased indique la capacité qui sera de nouveau disponible au renouvellement. Consultez Forfaits et options supplémentaires.
  • Reconnecter le même compte à la même marque est gratuit. Reconnecter un compte social que vous avez déconnecté de cette marque plus tôt au cours de la même période réutilise son emplacement existant : il repasse de connectionsReleased à connectionsActive et le nombre facturable connections ne change pas. Un emplacement est réservé par paire marque-compte ; un compte social différent nécessite donc un nouvel emplacement, tout comme le même compte associé à une autre marque.
  • L'archivage d'une marque déconnecte toutes ses connexions ; vous n'avez donc pas besoin d'effectuer cet appel au préalable lors de l'archivage. Dans ce cas aussi, les emplacements restent réservés jusqu'à la fin de la période : la méthode de libération ne change rien.

Opération d'écriture : non exécutée sur le compte réel. La requête et la réponse présentées sont construites à partir du schéma de l'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"    }  }'