v1Ressources/Locations/postPlanifier l'archivage d'un établissement

Planifier l'archivage d'un établissement

PLANIFIE l'archivage d'un établissement à la fin de la période de facturation en cours. L'établissement reste pleinement actif, facturable, et continue de compter dans la limite d'établissements du plan jusque-là — rien n'est supprimé, et la planification ne libère pas de place pour ajouter un autre établissement avant que l'archivage n'ait réellement lieu. Appelez cancel-archive pour annuler cela avant qu'il ne se produise, ou reactivate ensuite pour restaurer l'établissement.

post/api/v1/locations/{id}/archive

locations:write

Paramètres de requête

idstringobligatoire

L'établissement à planifier pour archivage.

Réponse

dataobjectfacultatif

scheduledbooleanfacultatif

Toujours true en cas de succès.

scheduledArchiveAtstringfacultatif

Date à laquelle l'archivage a été demandé (également le jeton sur lequel cancel-archive se base), au format horodatage ISO 8601, ou null si aucun n'est en attente.

archiveAtstringfacultatif

Date à laquelle l'archivage planifié aura réellement lieu — la limite de facturation de l'agence. Null si l'agence n'en a aucune.

Erreurs

401Clé API manquante, invalide, expirée ou révoquée.

403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.

404La ressource est introuvable, ou n'appartient pas à votre agence.

409La requête entre en conflit avec l'état actuel de la ressource — par exemple, modifier l'e-mail ou le téléphone d'un destinataire à qui un message a déjà été envoyé, ou une invitation d'équipe déjà acceptée (ou pas encore acceptée).

429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.

post/api/v1/locations/{id}/archive

Votre clé API

id *

{
  "data": {
    "scheduled": true,
    "scheduledArchiveAt": "2026-02-01T00:00:00.000Z",
    "archiveAt": "2026-03-01T00:00:00.000Z"
  }
}