Raw schema
{
"type": "object",
"properties": {
"event_id": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^\\S+$"
},
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
],
"description": "Event id (evt-...) to change."
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 300,
"description": "New title (single line)."
},
"datetime_start": {
"description": "New start: YYYY-MM-DD, YYYY-MM-DD hh:mm or YYYY-MM-DD hh:mm:ss.",
"type": "string"
},
"calendar_id": {
"description": "Move the event to this calendar id.",
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100,
"pattern": "^\\S+$"
},
{
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
]
},
"datetime_end": {
"description": "End date-time (default: start + 1 hour). Same formats as the start.",
"type": "string"
},
"all_day_event": {
"description": "All-day event: only the dates are used.",
"type": "boolean"
},
"timezone": {
"description": "IANA timezone for the start/end (default: the calendar's timezone), or 'floating'.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"recurring_rule": {
"description": "iCalendar recurrence rule such as FREQ=WEEKLY;COUNT=10. The start must match the rule. Omit for a one-off event; on update an empty string makes the event stop repeating.",
"type": "string",
"maxLength": 500
},
"description": {
"description": "Plain text or simple HTML (keep under ~500 characters for cross-browser links).",
"type": "string",
"maxLength": 10000
},
"internal_name": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Internal name, never shown publicly."
},
"location": {
"description": "Address or URL (meeting link). Use either location or location_id, not both.",
"type": "string",
"maxLength": 1000
},
"location_id": {
"description": "Id of a saved location (0 = none). Not together with location.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"organizer_name": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Organizer name (needs organizer_email)."
},
"organizer_email": {
"description": "Organizer e-mail (needs organizer_name).",
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"reminder": {
"description": "Minutes before the start for a calendar-app reminder (0-10800).",
"type": "integer",
"minimum": 0,
"maximum": 10800
},
"color": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"description": "Color 1-20 from the palette."
},
"free_busy": {
"description": "How the event shows in an attendee's calendar.",
"type": "string",
"enum": [
"free",
"busy",
"default"
]
},
"landing_page_template_id": {
"description": "Event landing page template id or 'default' (see addevent_list_event_templates).",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"rsvp_enabled": {
"description": "Require an RSVP before the event can be added to a calendar.",
"type": "boolean"
},
"rsvp_form_id": {
"description": "RSVP form id or 'default' (see addevent_list_rsvp_forms).",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"custom_data": {
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"description": "Arbitrary key-value pairs to store on the object (snake_case keys), e.g. an external id."
}
},
"required": [
"event_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}