Skip to main content

Calendar: Modify Event Tool

Usage

All Portia tools using API endpoints that require OAuth are built with plug and play authentication support. They use Portia client credentials including client ID, client name and redirect URL. Such tools will raise a Action Clarification with an OAuth link as the action URL. The portia.wait_for_ready() method must be used in this scenario: Portia's OAuth server will listen for the authentication result and resolve the concerned clarification, allowing your plan run to resume again.

For more on this, please visit to the section on running Portia tools ().

Tool details

Tool ID: portia:google:gcalendar:modify_event

Tool description: Modifies an existing Google Calendar event. You must provide the event ID to modify, and can optionally provide new values if desired for the title, start time, end time, description, and attendees.

Args schema:

{
"description": "Schema for modifying a Google Calendar event.",
"properties": {
"event_id": {
"description": "The ID of the event to modify, likely retrieved from portia:google:gcalendar:get_events_by_properties",
"title": "Event Id",
"type": "string"
},
"event_title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The new title of the calendar event",
"title": "Event Title"
},
"start_time": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The new start time in ISO format, e.g 2024-09-20T20:00:00Z",
"title": "Start Time"
},
"end_time": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The new end time in ISO format, e.g 2024-09-20T20:00:00Z",
"title": "End Time"
},
"event_description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The new description of the event",
"title": "Event Description"
},
"attendees": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "New list of attendees email addresses",
"title": "Attendees"
}
},
"required": [
"event_id"
],
"title": "GoogleCalendarModifyEventSchema",
"type": "object"
}

Output schema:

('dict', 'dict: Output of the tool')