v1Ressourcen/Locations/postArchivierung eines Standorts planen

Archivierung eines Standorts planen

PLANT die Archivierung eines Standorts zum Ende des aktuellen Abrechnungszeitraums. Der Standort bleibt bis dahin vollständig aktiv, abrechenbar und zählt weiterhin gegen das Standortlimit des Plans — nichts wird gelöscht, und die Planung schafft erst dann Platz für einen weiteren Standort, wenn die Archivierung tatsächlich eintritt. Rufen Sie cancel-archive auf, um dies vor Eintritt abzubrechen, oder danach reactivate, um den Standort zurückzuholen.

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

locations:write

Query-Parameter

idstringerforderlich

Der zur Archivierung zu planende Standort.

Antwort

dataobjectoptional

scheduledbooleanoptional

Bei Erfolg immer true.

scheduledArchiveAtstringoptional

Zeitpunkt, zu dem die Archivierung angefordert wurde (zugleich das Token, auf das cancel-archive abgleicht), 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.

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

Ihr API-Schlüssel

id *

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