Listings APIListings API
Iniciar sesión
POST/api/v4/social/brands/archive

Archivar una marca

Archiva una marca de redes sociales tras 90 días y desconecta sus conexiones al instante; retiene las plazas hasta el fin del ciclo 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.socialProfileIdstringobligatorioUUID of the brand to archive. Same value as the `brandId` path token used elsewhere.

Solicitud de ejemplo

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

Request body
{  "input": {    "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902"  }}

Respuestas

200Brand archived. Its connections are archived with it and go offline at once, but their slots stay counted against `maxConnections` until the billing period ends.
Response
{  "data": {    "archiveSocialProfile": {      "success": true,      "error": null,      "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",      "status": "ARCHIVED"    }  }}
200The brand is less than 90 days old and cannot be archived yet. `success` is `false` and `status` is `TENURE_NOT_MET`.
Response
{  "data": {    "archiveSocialProfile": {      "success": false,      "error": {        "message": "SY95051: Brand must be at least 90 days old before it can be archived",        "code": "SY95051",        "contextInfo": null      },      "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",      "status": "TENURE_NOT_MET"    }  }}
401Unauthenticated, missing or invalid API key.
404No brand with that ID on this account (`SY95043`).

Archiva una marca. El archivado es inmediato: una vez que la marca lleva al menos 90 días en la cuenta, esta llamada la archiva junto con todas las cuentas de redes sociales conectadas a ella en la misma solicitud, y esas cuentas dejan de publicar de inmediato.

Caso de uso: planificar la capacidad del próximo ciclo. Las marcas en sí son ilimitadas y no se contabilizan según el uso, por lo que el archivado no tiene que ver con la cantidad de marcas, sino con las conexiones. Si un cliente ha dejado el servicio, archivar su marca desconecta sus canales hoy y deja sus plazas pendientes de volver a estar disponibles en la renovación, que es lo que indica usage.connectionsReleased en GET /social/limits. Si necesitas esa capacidad antes, compra un paquete de conexiones: ese es el único cambio que surte efecto de inmediato.

Valores de estado en la respuesta:

  • ARCHIVED: la marca y sus conexiones están archivadas. Este es el único resultado satisfactorio.
  • TENURE_NOT_MET: la marca tiene menos de 90 días de antigüedad y aún no se puede archivar. success es false, error.code es SY95051 y la marca permanece sin cambios.

Notas.

  • El cuerpo de la solicitud debe estar contenido en un objeto input, y el campo es socialProfileId, no brandId.
  • Comprueba success, no el estado HTTP. Un fallo por incumplimiento de la permanencia es un HTTP 200 con success: false, status: "TENURE_NOT_MET" y SY95051 en error.
  • Una marca debe tener al menos 90 días de antigüedad para poder archivarse. Es la misma regla que se aplica a las ubicaciones; consulta Planes y complementos. Vuelve a intentarlo después del día 90 de la marca; no hay forma de eximirla de esta regla mediante la API.
  • Archivar una marca archiva sus conexiones. Todas las cuentas de redes sociales vinculadas a la marca se desconectan en la misma operación, y GET /social/limits lo refleja en la siguiente lectura con un valor menor de usage.connectionsActive y uno mayor de usage.connectionsReleased. El valor facturable de usage.connections permanece sin cambios hasta que comienza el siguiente período.
  • No hay nada que cancelar en la marca. El archivado en sí no espera al final de un ciclo de facturación, por lo que no tiene un estado programado ni una llamada de cancelación. Lo que sí se aplaza es la consecuencia en la facturación: las plazas de conexión liberadas, al igual que las de un paquete de complementos cancelado, vuelven a estar disponibles cuando se cierra el ciclo.

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/brands/archive' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902"    }  }'
Run in playground