Zum Inhalt
Für Agenten

calendar_event_invite

Manage Calendar Guests and Send Invitations

Markdown Tools als JSON

Beschreibung

Replace guests of an oona or Google event you organize and send invitation updates. This sends external email. Create an event with calendar_event_save first, then read its current version. Pass every desired guest email; [] removes guests and sends cancellations. Existing guests' RSVP is preserved. Use all for a complete series with its current series version. Workspace calendar write access and this separate tool grant are required.

Zugriff

Zugriffsprofil: gated. Module: calendar. Die Freigabe im Profil ersetzt keine Account-, Workspace- oder Rollenberechtigung.

Parameter

Name Typ Pflicht Beschreibung
account_id string Ja
calendar_id string Ja
event_id string Ja
expected_version integer Ja
guests array Ja
series_scope string Nein
expected_series_version integer Nein

Eingabeschema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "account_id": {
      "type": "string"
    },
    "calendar_id": {
      "type": "string"
    },
    "event_id": {
      "type": "string"
    },
    "expected_version": {
      "type": "integer",
      "minimum": 0
    },
    "guests": {
      "type": "array",
      "maxItems": 200,
      "items": {
        "type": "string",
        "maxLength": 254
      }
    },
    "series_scope": {
      "type": "string",
      "enum": [
        "this",
        "all",
        "future"
      ]
    },
    "expected_series_version": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "account_id",
    "calendar_id",
    "event_id",
    "expected_version",
    "guests"
  ],
  "type": "object"
}

Ausgabeschema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "event": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "calendar_id": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "location": {
          "type": [
            "string",
            "null"
          ]
        },
        "starts_at": {
          "type": "string"
        },
        "ends_at": {
          "type": "string"
        },
        "all_day": {
          "type": "boolean"
        },
        "start_on": {
          "type": [
            "string",
            "null"
          ]
        },
        "end_on": {
          "type": [
            "string",
            "null"
          ]
        },
        "time_zone": {
          "type": "string"
        },
        "version": {
          "type": "integer"
        },
        "google_meet_url": {
          "type": [
            "string",
            "null"
          ]
        },
        "conference_status": {
          "type": [
            "string",
            "null"
          ]
        },
        "reminders": {
          "type": "object",
          "properties": {
            "useDefault": {
              "type": "boolean"
            },
            "overrides": {
              "type": "array",
              "maxItems": 5,
              "items": {
                "type": "object",
                "properties": {
                  "method": {
                    "type": "string",
                    "enum": [
                      "popup",
                      "email"
                    ]
                  },
                  "minutes": {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 40320
                  }
                },
                "required": [
                  "method",
                  "minutes"
                ]
              }
            }
          }
        },
        "recurrence": {
          "type": "object",
          "properties": {
            "frequency": {
              "type": "string",
              "enum": [
                "none",
                "daily",
                "weekly",
                "monthly",
                "yearly"
              ]
            },
            "interval": {
              "type": "integer",
              "minimum": 1,
              "maximum": 99
            },
            "weekdays": {
              "type": "array",
              "maxItems": 7,
              "items": {
                "type": "integer",
                "minimum": 1,
                "maximum": 7
              }
            },
            "monthly_mode": {
              "type": "string",
              "enum": [
                "date",
                "weekday",
                "last_weekday",
                "last_day"
              ]
            },
            "ends_on": {
              "type": "string"
            },
            "count": {
              "type": "integer",
              "minimum": 1,
              "maximum": 1000
            }
          }
        },
        "series_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "series_version": {
          "type": [
            "integer",
            "null"
          ]
        },
        "google_recurrence": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Original Google RRULE/EXDATE/RDATE entries; preserved when recurrence is omitted on updates. Read the event directly for a fresh series version."
        },
        "invitation": {
          "type": "boolean"
        },
        "response_status": {
          "type": [
            "string",
            "null"
          ]
        },
        "organizer": {
          "type": [
            "string",
            "null"
          ]
        },
        "guests": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "email": {
                "type": "string"
              },
              "displayName": {
                "type": "string"
              },
              "responseStatus": {
                "type": "string"
              },
              "optional": {
                "type": "boolean"
              },
              "organizer": {
                "type": "boolean"
              },
              "self": {
                "type": "boolean"
              }
            }
          }
        },
        "can_manage_guests": {
          "type": "boolean"
        },
        "can_edit_reminders": {
          "type": "boolean"
        },
        "can_respond": {
          "type": "boolean"
        },
        "recurring_occurrence": {
          "type": "boolean"
        },
        "writable": {
          "type": "boolean"
        }
      },
      "required": [
        "id",
        "calendar_id",
        "title",
        "starts_at",
        "ends_at",
        "all_day",
        "time_zone",
        "version",
        "invitation",
        "can_respond",
        "recurring_occurrence",
        "writable"
      ]
    }
  },
  "required": [
    "event"
  ],
  "type": "object"
}
Seiten