Ein Rechtsdokument aktualisieren

PATCH /v1/legal-documents/{id} · Berechtigung legal-documents:write

Ändert nur requires_reacceptance und, solange das Dokument noch nicht in Kraft ist, effective_at (JSON Merge Patch, RFC 7396). Andere Felder sind nicht im Schema (400 unknown_field), und keines der beiden Felder darf null sein. Ein Patch ohne Änderung schreibt nicht und gibt das Dokument unverändert zurück. Dokumente haben keine Version, daher wird If-Match nicht verwendet.

Anfrage

Pfadparameter:

Feld Typ Erforderlich Beschreibung
id string ja Dokument-ID (ldoc_…).

JSON merge patch (application/merge-patch+json)-Body (unbekannte Felder werden mit 400 unknown_field abgelehnt):

Feld Typ Erforderlich Beschreibung
requires_reacceptance boolean nein Neuer Wert; darf nicht null sein.
effective_at string (date-time) nein Nur solange das Dokument noch nicht in Kraft ist; nicht in der Vergangenheit.

Antwort

200 OK mit dem Dokument.

{
  "id": "ldoc_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "application_id": null,
  "kind": "terms",
  "version": "2026-10",
  "locale": "en",
  "url": "https://example.com/legal/terms-2026-10",
  "content_sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
  "effective_at": "2026-11-01T00:00:00Z",
  "requires_reacceptance": true,
  "created_at": "2026-10-05T09:30:00.123456Z",
  "updated_at": "2026-10-05T09:30:00.123456Z"
}

Fehler

HTTP Code Wann
400 unknown_field Der Patch enthält ein anderes Feld als requires_reacceptance und effective_at oder ist kein JSON-Objekt (malformed_request).
404 not_found Das Dokument existiert nicht oder gehört einer anderen Umgebung.
415 unsupported_media_type Der Content-Type ist nicht application/merge-patch+json.
422 validation_failed Ein Feld ist null (invalid), effective_at ist missgestaltet oder in der Vergangenheit, oder das Dokument ist bereits in Kraft (immutable).
401 unauthenticated Die Anmeldedaten fehlen, sind ungültig oder wurden widerrufen.
403 insufficient_permissions Die Anmeldedaten haben nicht die erforderliche Berechtigung.
429 rate_limited Die Rate-Grenze wurde überschritten; Wiederhole nach dem Retry-After-Zeitraum.
503 service_unavailable Eine Abhängigkeit ist vorübergehend nicht verfügbar; Wiederhole nach dem Retry-After-Zeitraum.

Beispiel

curl -X PATCH https://api.eu.keenauth.com/v1/legal-documents/ldoc_01j9xk3m7q8r2s4t6v8w0y2z4a \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{"requires_reacceptance":true}'