update_public_calendar

Diese Referenz wird aus dem veröffentlichten Werkzeugvertrag erzeugt. Feldnamen und normative Beschreibungen im Schema sind Englisch.

Verhalten und Grenzen

Ändert Name, Beschreibung, Zeitzone, Sprache, Standarddauer, Farbe, Website oder ob die nächsten Termine auf der Abo-Seite stehen. Überschreibt die angegebenen Felder; Abonnenten sehen die Änderung beim nächsten Abruf. mode=live schaltet einen Test-Kalender live: [TEST] verschwindet aus dem Namen und er zählt zu den Live-Kalendern des Tarifs; zurück in den Testmodus geht es nicht. Vor dem Live-Schalten mit dem Nutzer abstimmen.

Berechtigungen

Freigegebene Scopes, Konten, Kalender und Sichtbarkeitsregeln begrenzen den Zugriff. Ein Workspace-Admin erhält dadurch keinen pauschalen Zugriff auf fremde Konten.

public_calendars:write

Freigaben und Grenzen

Eingabe

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "calendar_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "Calendar id from list_public_calendars."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "description": {
      "type": "string",
      "maxLength": 1000
    },
    "timezone": {
      "description": "IANA time zone, e.g. \"Europe/Berlin\". Default for events without their own zone.",
      "type": "string",
      "maxLength": 64
    },
    "language": {
      "type": "string",
      "enum": [
        "de",
        "en"
      ]
    },
    "default_duration_minutes": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1440
    },
    "brand_color": {
      "type": "string",
      "pattern": "^#[0-9a-fA-F]{6}$"
    },
    "site_url": {
      "type": "string",
      "maxLength": 2000,
      "format": "uri"
    },
    "show_events": {
      "type": "boolean"
    },
    "mode": {
      "description": "Switch a test calendar to live. Omit to keep the mode.",
      "type": "string",
      "const": "live"
    }
  },
  "required": [
    "calendar_id"
  ],
  "additionalProperties": false
}

Ausgabe

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "calendar": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "mode": {
          "type": "string",
          "enum": [
            "live",
            "test"
          ]
        },
        "name": {
          "type": "string"
        },
        "timezone": {
          "type": "string"
        },
        "feed_url": {
          "type": "string"
        },
        "subscribe_links": {
          "type": "object",
          "properties": {
            "google": {
              "type": "string"
            },
            "outlook": {
              "type": "string"
            },
            "office365": {
              "type": "string"
            },
            "apple": {
              "type": "string"
            }
          },
          "required": [
            "google",
            "outlook",
            "office365",
            "apple"
          ],
          "additionalProperties": false
        },
        "event_count": {
          "type": "number"
        },
        "active_subscribers": {
          "type": "number"
        },
        "console_url": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "mode",
        "name",
        "timezone",
        "feed_url",
        "subscribe_links",
        "event_count",
        "active_subscribers",
        "console_url"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "calendar"
  ],
  "additionalProperties": false
}

Fehler und Wiederholungen

Prüfe das Werkzeugergebnis auf Fehler. Wiederhole Schreiboperationen nicht blind nach einem Timeout. Prüfe zuerst den aktuellen Ressourcen- oder Sendestatus.

Fehlerbehandlung