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

Desconectar uma listagem de um local

Desvincula a listagem conectada da plataforma de publicação de um único local da Listings API.

Requer uma chave de API. Consulte Autenticação para ver o formato do cabeçalho e a rotação de chaves.

Parâmetros

Corpo

NomeTipoObrigatórioDescrição
inputobjectobrigatórioWrapper object. The entire request body must be nested under `input`.
input.locationIdstringobrigatórioBase64-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`.

Exemplo de requisição

Corpo pronto para colar. Substitua os IDs e valores de exemplo pelos seus.

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

Respostas

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

Remove o vínculo entre um local da Listings API e a listagem da plataforma de publicação (Google Business Profile, Página do Facebook ou Apple Business Connect) à qual ele está conectado no momento. Após a desconexão, a Listings API para de enviar atualizações para essa listagem. O local permanece na sua conta; apenas o vínculo com a listagem é removido.

Formato da solicitação. O corpo deve estar encapsulado em um objeto input que contenha um único locationId, além de uma destas opções: site (GOOGLE, FACEBOOK ou APPLE) ou providerId para indicar qual conexão remover. Este endpoint não permite operações em lote: é um local por chamada, então use um loop se precisar desconectar vários.

Se você não enviar nem site nem providerId, o endpoint retornará SY10056 ("Site is not valid for the location disconnection"). Para um local que não tem uma conexão ativa com esse site, o endpoint retorna SY10057 ("Location is not connected for the site") em vez de indicar sucesso silenciosamente, portanto, um success: true realmente significa que um vínculo foi removido.

Caso de uso: redirecionar um local para outra conta. Quando um cliente transfere uma loja de uma conta do Google para outra, primeiro desconecte a listagem atual do local aqui com site: "GOOGLE" e depois use trigger-matches e connect-listing na nova conta conectada para vincular o local à listagem correta.

Caso de uso: encerrar o gerenciamento sem excluir. Quando um cliente muda para um plano inferior e não quer mais que a Listings API gerencie sua presença no Google/Facebook, mas quer manter o registro do local e seus dados hospedados na Listings API, desconecte a listagem em vez de arquivar o local. Isso interrompe a sincronização de saída e preserva o local para outras plataformas de publicação.

Este endpoint altera uma conexão ativa e envia a alteração para a plataforma de publicação. A solicitação e a resposta de exemplo acima são ilustrativas.

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