POST/api/v4/connected-accounts/disconnect-listing

Desconectar una ficha de una ubicación

Desvincula la ficha conectada de la plataforma de publicación de una sola ubicación de Listings API.

Requiere una clave de API. Consulta Autenticación para conocer el formato del encabezado y la rotación de claves.

Parámetros

Cuerpo

NombreTipoObligatorioDescripción
inputobjectobligatorioWrapper object. The entire request body must be nested under `input`.
input.locationIdstringobligatorioBase64-encoded Relay ID of the one location to disconnect.
input.sitestringopcionalPublisher to disconnect from: `GOOGLE`, `FACEBOOK`, or `APPLE`. Required unless you send `providerId`.
input.providerIdstringopcionalThe publisher's own account identifier, as an alternative to `site`. Required unless you send `site`.

Solicitud de ejemplo

Cuerpo listo para pegar. Sustituye los ID y valores de ejemplo por los tuyos.

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

Respuestas

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

Elimina el vínculo entre una ubicación de Listings API y la ficha de la plataforma de publicación (Google Business Profile, Facebook Page o Apple Business Connect) a la que está conectada actualmente. Tras la desconexión, Listings API deja de enviar actualizaciones a esa ficha. La ubicación permanece en tu cuenta; solo se elimina el vínculo con la ficha.

Estructura de la solicitud. El cuerpo debe estar encapsulado en un objeto input que contenga un único locationId, además de o bien site (GOOGLE, FACEBOOK o APPLE) o bien providerId para indicar qué conexión se debe eliminar. Este endpoint no admite operaciones en bloque: solo permite una ubicación por llamada, así que utiliza un bucle si necesitas procesar varias.

Si no envías ni site ni providerId, el endpoint devuelve SY10056 ("El sitio no es válido para la desconexión de la ubicación"). Si una ubicación no tiene ninguna conexión activa con ese sitio, el endpoint devuelve SY10057 ("La ubicación no está conectada al sitio") en lugar de indicar que la operación se ha completado correctamente sin avisar, por lo que un success: true sí significa que se ha eliminado un vínculo.

Caso de uso: vincular una ubicación a una cuenta diferente. Cuando un cliente traslada un establecimiento de una cuenta de Google a otra, primero desconecta aquí la ficha actual de la ubicación con site: "GOOGLE" y luego utiliza trigger-matches y connect-listing en la nueva cuenta conectada para vincular la ubicación a la ficha correcta.

Caso de uso: dar de baja sin eliminar. Cuando un cliente cambia a un plan inferior y ya no quiere que Listings API gestione su presencia en Google/Facebook, pero quiere conservar el registro de la ubicación y sus datos alojados en Listings API, desconecta la ficha en lugar de archivar la ubicación. Esto detiene la sincronización saliente y conserva la ubicación para otras plataformas de publicación.

Este endpoint modifica una conexión activa y envía el cambio a la plataforma de publicación. La solicitud y la respuesta de muestra anteriores son ejemplos.

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