v1Ressourcen/Clients/postGeplante Archivierung abbrechen

Geplante Archivierung abbrechen

Bricht eine ausstehende Kundenarchivierung ab, sodass ein zur Archivierung am Ende des Abrechnungszeitraums geplanter Kunde normal weiterläuft. Gibt auch die zusammen damit geplanten Standorte wieder frei. Funktioniert nur, solange die Archivierung noch ausstehend ist — ein bereits vollständig archivierter Kunde muss stattdessen über den reactivate-Endpunkt wiederhergestellt werden.

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

clients:write

Query-Parameter

idstringerforderlich

Der Kunde, dessen ausstehende Archivierung abgebrochen werden soll.

Antwort

dataobjectoptional

cancelledbooleanoptional

Bei Erfolg immer true.

locationsReleasednumberoptional

Anzahl der aus dem abgebrochenen Archivierungsplan freigegebenen Standorte.

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.

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

Ihr API-Schlüssel

id *

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