v1Ressources/Clients/postAnnuler un archivage planifié

Annuler un archivage planifié

Annule un archivage de client en attente, afin qu'un client planifié pour archivage à la fin de la période de facturation continue normalement. Libère également les établissements qui étaient planifiés avec lui. Ne fonctionne que tant que l'archivage est encore en attente — un client déjà entièrement archivé doit plutôt être réactivé, via l'endpoint reactivate.

post/api/v1/clients/{id}/cancel-archive

clients:write

Paramètres de requête

idstringobligatoire

Le client dont l'archivage en attente doit être annulé.

Réponse

dataobjectfacultatif

cancelledbooleanfacultatif

Toujours true en cas de succès.

locationsReleasednumberfacultatif

Nombre d'établissements libérés de la planification d'archivage annulée.

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/clients/{id}/cancel-archive

Votre clé API

id *

{
  "data": {
    "cancelled": true,
    "locationsReleased": 1
  }
}