Synup
Créer une clé
v1Ressources/Clients/deleteArchiver un client

Archiver un client

Demande l'archivage d'un client — cette API ne le supprime jamais définitivement. Si le client possède des établissements, cela PLANIFIE l'opération : le client et tous ses établissements s'archivent à la fin de la période de facturation en cours, et jusque-là tout reste pleinement actif et facturé — l'archivage peut être annulé via l'endpoint cancel-archive. Un client sans aucun établissement est en revanche archivé immédiatement (il n'y a rien à différer). Le champ outcome de la réponse indique lequel des deux s'est réellement produit.

delete/api/v1/clients/{id}
clients:write
Paramètres de requête
idstringobligatoire
Le client à archiver.
Réponse
dataobjectfacultatif
Les champs présents dépendent de outcome : scheduled contient scheduledArchiveAt/archiveAt/locationCount ; archived contient locationsArchived/locationsFailed/cancelledScheduledPosts.
outcomestring (scheduled | archived)obligatoire
Ce qui s'est réellement passé : archived (immédiat — aucun établissement n'existait, ou aucun n'était actif) ou scheduled (archivage à la fin de la période de facturation).
clientIdstringobligatoire
Identifiant unique du client.
businessNamestringobligatoire
Le nom commercial du client.
scheduledArchiveAtstringfacultatif
Date à laquelle l'archivage a été demandé (aussi le jeton de cohorte pour l'annuler), 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. Présent uniquement lorsque outcome est scheduled.
locationCountnumberfacultatif
Nombre d'établissements de ce client, ou null si inconnu.
locationsArchivednumberfacultatif
Nombre d'établissements archivés avec le client. Présent uniquement lorsque outcome est archived.
locationsFailednumberfacultatif
Nombre d'établissements dont l'archivage a échoué. Présent uniquement lorsque outcome est archived.
cancelledScheduledPostsnumberfacultatif
Nombre de publications planifiées annulées dans le cadre de l'archivage. Présent uniquement lorsque outcome est archived.
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.
delete/api/v1/clients/{id}
Votre clé API
id *
{
  "data": {
    "outcome": "scheduled",
    "clientId": "cli_123",
    "businessName": "Acme Dental",
    "scheduledArchiveAt": "2026-02-01T00:00:00.000Z",
    "archiveAt": "2026-03-01T00:00:00.000Z",
    "locationCount": 1
  }
}

Guides qui utilisent cette ressource