Listings APIListings API
Se connecter
POST/api/v4/social/brands/archive

Archiver une marque

Archive une marque sur les réseaux sociaux après 90 jours, coupe aussitôt ses connexions et réserve leurs places jusqu’à la fin du cycle de facturation.

Nécessite une clé API. Consultez Authentification pour le format de l’en-tête et la rotation des clés.

Paramètres

Corps

NomTypeObligatoireDescription
inputobjectobligatoireWrapper object. The entire request body must be nested under `input`.
input.socialProfileIdstringobligatoireUUID of the brand to archive. Same value as the `brandId` path token used elsewhere.

Exemple de requête

Corps prêt à coller. Remplacez les identifiants et valeurs d’exemple par les vôtres.

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

Réponses

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`).

Archive une marque. L’archivage est immédiat : dès lors que la marque est présente sur le compte depuis au moins 90 jours, cet appel l’archive ainsi que tous les comptes de réseaux sociaux qui lui sont connectés dans la même requête, et ces comptes cessent immédiatement de publier.

Cas d’utilisation : planifier la capacité du prochain cycle. Les marques elles-mêmes sont illimitées et ne sont pas comptabilisées ; l’archivage ne concerne donc pas le nombre de marques, mais les connexions. Si un client vous a quitté, l’archivage de sa marque met ses canaux hors ligne dès aujourd’hui et prévoit que leurs emplacements redeviennent disponibles au renouvellement, ce qu’indique usage.connectionsReleased dans GET /social/limits. Si vous avez besoin de cette capacité avant cette échéance, achetez un pack de connexions — c’est le seul changement qui prend effet immédiatement.

Valeurs de statut dans la réponse :

  • ARCHIVED : la marque et ses connexions sont archivées. C’est le seul résultat indiquant une réussite.
  • TENURE_NOT_MET : la marque a moins de 90 jours d’ancienneté et ne peut pas encore être archivée. success vaut false, error.code vaut SY95051, et la marque reste inchangée.

Remarques.

  • Le corps de la requête doit être encapsulé dans un objet input, et le champ est socialProfileId, pas brandId.
  • Vérifiez success, pas le statut HTTP. Un échec lié à l’ancienneté se traduit par HTTP 200 avec success: false, status: "TENURE_NOT_MET" et SY95051 dans error.
  • Une marque doit avoir au moins 90 jours d’ancienneté pour être archivée. C’est la même règle que celle qui s’applique aux établissements ; consultez Forfaits et modules complémentaires. Réessayez après le 90e jour de la marque ; il n’est pas possible de déroger à cette règle via l’API.
  • L’archivage d’une marque archive ses connexions. Tous les comptes de réseaux sociaux liés à la marque sont déconnectés au cours de la même opération, et GET /social/limits le reflète à la lecture suivante par une valeur plus faible de usage.connectionsActive et une valeur plus élevée de usage.connectionsReleased. La valeur facturable de usage.connections reste inchangée jusqu’au début de la période suivante.
  • Il n’y a rien à annuler au niveau de la marque. L’archivage lui-même n’attend pas la fin d’un cycle de facturation ; il n’existe donc ni état planifié ni appel permettant de l’annuler. Ce qui est différé, c’est la conséquence sur la facturation : les emplacements de connexion libérés, comme ceux d’un pack complémentaire résilié, redeviennent disponibles à la clôture du cycle.

Opération d’écriture : non exécutée sur le compte en production. La requête et la réponse présentées sont construites à partir du schéma de l’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