Listings APIListings API
Se connecter
POST/api/v4/connected-accounts/disconnect-listing

Déconnecter une fiche d’un établissement

Dissocie la fiche connectée sur la plateforme de publication d’un seul établissement dans Listings API.

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.locationIdstringobligatoireBase64-encoded Relay ID of the one location to disconnect.
input.sitestringfacultatifPublisher to disconnect from: `GOOGLE`, `FACEBOOK`, or `APPLE`. Required unless you send `providerId`.
input.providerIdstringfacultatifThe publisher's own account identifier, as an alternative to `site`. Required unless you send `site`.

Exemple de requête

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

Request body
{  "input": {    "locationId": "TG9jYXRpb246MTgwMDI4OQ==",    "site": "GOOGLE"  }}

Réponses

200Listing disconnected.
Response
{  "data": {    "disconnectConnectedAccountsLocations": {      "clientMutationId": null,      "success": true,      "errors": null    }  }}
401Unauthenticated, missing or invalid API key.

Supprime le lien entre un établissement dans Listings API et la fiche sur la plateforme de publication (Google Business Profile, Facebook Page ou Apple Business Connect) à laquelle il est actuellement connecté. Après la déconnexion, Listings API cesse d’envoyer des mises à jour à cette fiche. L’établissement lui-même reste dans votre compte ; seul le lien avec la fiche est supprimé.

Structure de la requête. Le corps doit être encapsulé dans un objet input contenant un seul locationId, ainsi que soit site (GOOGLE, FACEBOOK ou APPLE), soit providerId pour indiquer la connexion à supprimer. Cet endpoint ne permet pas les opérations en masse : un seul établissement par appel, vous devez donc utiliser une boucle pour en traiter plusieurs.

Si vous n’envoyez ni site ni providerId, l’endpoint renvoie SY10056 (« Site is not valid for the location disconnection »). Si un établissement n’a aucune connexion active pour ce site, l’endpoint renvoie SY10057 (« Location is not connected for the site ») plutôt qu’un succès silencieux ; un success: true signifie donc bien qu’un lien a été supprimé.

Cas d’utilisation : rattacher un établissement à un autre compte. Lorsqu’un client transfère un point de vente d’un compte Google à un autre, déconnectez d’abord ici la fiche actuelle de l’établissement avec site: "GOOGLE", puis utilisez trigger-matches et connect-listing sur le nouveau compte connecté pour le relier à la bonne fiche.

Cas d’utilisation : arrêter la gestion sans supprimer. Lorsqu’un client passe à une offre inférieure et ne souhaite plus que Listings API gère sa présence sur Google/Facebook, mais souhaite conserver l’enregistrement de l’établissement et ses données hébergées par Listings API, déconnectez la fiche plutôt que d’archiver l’établissement. Cela arrête la synchronisation sortante tout en préservant l’établissement pour les autres plateformes de publication.

Cet endpoint modifie une connexion active et transmet la modification à la plateforme de publication. La requête et la réponse présentées ci-dessus sont des exemples.

Request
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/disconnect-listing' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "locationId": "TG9jYXRpb246MTgwMDI4OQ==",      "site": "GOOGLE"    }  }'
Run in playground