POST/api/v4/social/connections/disconnect

Desconectar una conexión

Desconecta de inmediato una cuenta social conectada; su plaza en el cupo compartido de la cuenta se reserva hasta el fin del período de facturación.

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

Solicitud de ejemplo

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

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

Respuestas

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.

Elimina una cuenta social conectada de su marca. La marca no se especifica directamente: el ID de la conexión identifica a ambas. Esta operación es irreversible, sin plazo de cancelación y sin posibilidad de deshacerla. Para restablecer el canal, genera un nuevo enlace de conexión y pide al usuario que vuelva a autorizar el acceso.

Caso de uso: un cliente revoca el acceso a un canal. Cuando un cliente retira una página de tu control, desconecta ese canal para que las publicaciones programadas dejen de intentar publicarse en él. Obtén el id de las conexiones de la marca, desconecta la conexión y vuelve a consultar la lista para confirmarlo.

Notas.

  • El cuerpo de la solicitud debe estar envuelto en un objeto input. El campo es socialProfileConnectedChannelId: el UUID de la propia conexión, no el connectedAccountId de la plataforma ni el ID de la marca.
  • Comprueba success, no el estado HTTP. Una conexión que pertenece a otra marca o que ya no existe devuelve HTTP 200 con success: false. El contenido de la respuesta no incluye ningún ID, así que lleva tu propio registro de la conexión que has solicitado eliminar.
  • Ten cuidado con los nombres parecidos. Este campo del cuerpo es socialProfileConnectedChannelId, con Profile en medio. El endpoint de estadísticas adyacente recibe socialConnectedChannelId: el mismo ID, con una palabra menos. Se diferencian en una palabra y ninguno acepta el nombre del otro.
  • Las publicaciones programadas no se cancelan. Una publicación programada para este canal fallará en el momento de publicarse con SY95045 en lugar de descartarse. Cancélala primero con POST /social/posts/cancel si no quieres que se produzca el fallo.
  • Las publicaciones ya publicadas siguen visibles. La desconexión elimina la capacidad de listingsAPI para publicar y consultar estadísticas; no elimina nada de la plataforma.
  • La plaza vuelve al conjunto compartido en la renovación, no cuando la operación se completa correctamente. GET /social/limits lo muestra de inmediato con un valor menor de usage.connectionsActive y uno mayor de usage.connectionsReleased, mientras que usage.connections —la cantidad facturable a la que se aplica el límite— permanece sin cambios hasta el inicio del siguiente período de facturación. usage.connectionsReleased indica cuánta capacidad se recupera en la renovación. Consulta Planes y complementos.
  • Volver a vincular la misma cuenta a la misma marca es gratis. Volver a conectar una cuenta social que desconectaste de esa marca anteriormente en el mismo período reutiliza su plaza existente: vuelve a pasar de connectionsReleased a connectionsActive y el valor facturable de connections no cambia. Se reserva una plaza por cada pareja de marca y cuenta, por lo que una cuenta social diferente ocupa una plaza nueva, al igual que la misma cuenta en una marca diferente.
  • Archivar una marca desconecta todas sus conexiones, así que no necesitas realizar esta llamada antes de archivarla. En ese caso, las plazas también quedan reservadas hasta el final del período; el método de liberación no cambia nada.

Operación de escritura: no se ha ejecutado en la cuenta real. La solicitud y la respuesta mostradas se han generado a partir del esquema de la 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"    }  }'