v1Ressourcen/Clients/deleteClient archivieren

Client archivieren

Fordert die Archivierung eines Kunden an — diese API löscht einen Kunden niemals endgültig. Hat der Kunde Standorte, wird dies GEPLANT: Kunde und alle seine Standorte archivieren am Ende des aktuellen Abrechnungszeitraums, bis dahin bleibt alles vollständig aktiv und wird abgerechnet — die Archivierung kann über den cancel-archive-Endpunkt zurückgenommen werden. Ein Kunde ganz ohne Standorte wird stattdessen sofort archiviert (es gibt nichts aufzuschieben). Das outcome-Feld der Antwort zeigt, welcher der beiden Fälle tatsächlich eingetreten ist.

delete/api/v1/clients/{id}

clients:write

Query-Parameter

idstringerforderlich

Der zu archivierende Kunde.

Antwort

dataobjectoptional

Welche Felder vorhanden sind, hängt von outcome ab: scheduled enthält scheduledArchiveAt/archiveAt/locationCount; archived enthält locationsArchived/locationsFailed/cancelledScheduledPosts.

outcomestring (scheduled | archived)erforderlich

Was tatsächlich passiert ist: archived (sofort — es gab keine Standorte, oder keiner war aktiv) oder scheduled (archiviert am Ende des Abrechnungszeitraums).

clientIdstringerforderlich

Eindeutige Kennung des Kunden.

businessNamestringerforderlich

Der Firmenname des Kunden.

scheduledArchiveAtstringoptional

Zeitpunkt, zu dem die Archivierung angefordert wurde (zugleich das Kohorten-Token, um sie abzubrechen), als ISO-8601-Zeitstempel, oder null, wenn keine ausstehend ist.

archiveAtstringoptional

Wann die geplante Archivierung tatsächlich eintritt — die Abrechnungsgrenze der Agentur. Null, wenn die Agentur keine hat. Nur vorhanden, wenn outcome scheduled ist.

locationCountnumberoptional

Anzahl der Standorte dieses Kunden, oder null, falls unbekannt.

locationsArchivednumberoptional

Anzahl der zusammen mit dem Kunden archivierten Standorte. Nur vorhanden, wenn outcome archived ist.

locationsFailednumberoptional

Anzahl der Standorte, deren Archivierung fehlgeschlagen ist. Nur vorhanden, wenn outcome archived ist.

cancelledScheduledPostsnumberoptional

Anzahl der im Rahmen der Archivierung abgebrochenen geplanten Beiträge. Nur vorhanden, wenn outcome archived ist.

Fehler

401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.

403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.

404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.

409Die Anfrage steht im Widerspruch zum aktuellen Zustand der Ressource — zum Beispiel beim Ändern der E-Mail-Adresse oder Telefonnummer eines Empfängers, dem bereits eine Nachricht gesendet wurde, oder bei einer Team-Einladung, die bereits akzeptiert wurde (oder noch nicht akzeptiert wurde).

429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.

delete/api/v1/clients/{id}

Ihr API-Schlüssel

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
  }
}