POST/api/v4/social/connections/disconnect

Desconectar uma conexão

Coloca uma conta social conectada offline imediatamente; sua vaga no conjunto compartilhado da conta fica reservada até o fim do período de cobrança.

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.socialProfileConnectedChannelIdstringobrigatórioUUID of the connection to remove, the `id` of a row from GET /social/brands/{brandId}/connections.

Exemplo de requisição

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

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

Respostas

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.

Remove uma conta social conectada da marca à qual ela pertence. A marca não é especificada diretamente: o ID da conexão identifica ambas. Esta é uma operação irreversível, sem prazo para cancelamento e sem possibilidade de desfazê-la. Para restaurar o canal, gere um novo link de conexão e peça ao usuário que autorize novamente.

Caso de uso: um cliente revoga o acesso a um canal. Quando um cliente retira uma Página do seu controle, desconecte esse canal para que as publicações agendadas parem de tentar publicar nele. Leia o id nas conexões da marca, desconecte a conexão e consulte a lista novamente para confirmar.

Observações.

  • O corpo da requisição deve estar dentro de um objeto input. O campo é socialProfileConnectedChannelId — o UUID da própria conexão, não o connectedAccountId da plataforma nem o ID da marca.
  • Verifique success, não o status HTTP. Uma conexão que pertence a outra marca ou que já foi removida retorna HTTP 200 com success: false. O payload não contém nenhum ID, então mantenha seu próprio registro de qual conexão você solicitou remover.
  • Atenção aos nomes parecidos. Este campo do corpo é socialProfileConnectedChannelId, com Profile no meio. O endpoint de insights adjacente recebe socialConnectedChannelId — o mesmo ID, com uma palavra a menos no nome do campo. Os nomes diferem por uma palavra, e nenhum dos dois aceita o nome do outro.
  • As publicações agendadas não são canceladas. Uma publicação agendada para este canal falhará no momento da publicação com SY95045, em vez de ser descartada. Cancele-a primeiro com POST /social/posts/cancel se você não quiser que essa falha ocorra.
  • As publicações já publicadas continuam no ar. Desconectar remove a capacidade da listingsAPI de publicar e ler insights; isso não exclui nada da plataforma.
  • A vaga retorna ao conjunto compartilhado na renovação, não quando a chamada é concluída com sucesso. GET /social/limits mostra isso imediatamente como um valor menor de usage.connectionsActive e um valor maior de usage.connectionsReleased, enquanto usage.connections — a quantidade faturável à qual o limite se aplica — permanece inalterado até o início do próximo período de cobrança. usage.connectionsReleased é a quantidade de capacidade recuperada na renovação. Consulte Planos e complementos.
  • Vincular novamente a mesma conta à mesma marca é gratuito. Reconectar uma conta social que você desconectou dessa marca anteriormente no mesmo período reutiliza a vaga existente: ela sai de connectionsReleased e volta para connectionsActive, e a quantidade faturável connections não muda. Uma vaga fica reservada por par de marca e conta, portanto, uma conta social diferente exige uma nova vaga, assim como a mesma conta em outra marca.
  • Arquivar uma marca desconecta todas as conexões dela, portanto, você não precisa fazer esta chamada antes de arquivar. Nesse caso, as vagas também ficam reservadas até o fim do período — a forma de liberação não faz diferença.

Operação de escrita: não executada na conta real. A requisição e a resposta exibidas são construídas a partir do esquema da 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"    }  }'