Microsoft_Calendar
Update the properties of an existing event. Can modify subject, attendees, times, location, body, importance, reminders, online meeting settings, and other event properties. Use PATCH to update only specified fields while preserving others.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Event properties to update. Only include fields you want to change.
Successful Response
Validation Error
Delete a specific event from the calendar. If the event is a meeting, deleting it on the organizer's calendar sends a cancellation message to all attendees. This action cannot be undone.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Permanently delete an event and place it in the purges folder in the dumpster. Unlike regular delete, this action moves the event to a deeper deletion state that cannot be recovered by standard means. Email clients cannot access permanently deleted items.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Get all the user's calendars. This retrieves calendars from the default calendar group and allows filtering, sorting, and selecting specific properties using OData query parameters.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Query parameters for customizing the calendar list
Successful Response
Validation Error
Create a new calendar for the user. This creates a calendar in the user's default calendar group with the specified name and optional properties like color.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Get the properties and relationships of a specific calendar object by its ID. This retrieves detailed information about a calendar including permissions, settings, and metadata.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Query parameters for customizing the calendar details
Successful Response
Validation Error
Update the properties of an existing calendar object. You can modify the calendar name, color theme, or default calendar status. Only include properties you want to update.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Delete a calendar other than the default calendar. This permanently removes the calendar and all its events. The default calendar cannot be deleted.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Get events, occurrences, exceptions and single instances from a calendar within a specified time range. This returns actual calendar events/appointments between the start and end dates.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Optional request headers for customizing the response
Successful Response
Validation Error
Retrieve a list of all events in a calendar without date restrictions. This returns single instance meetings, series masters, and recurring events. Use this to get all events in a calendar regardless of time range.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Query parameters for customizing the event list
Optional request headers for customizing the response
Successful Response
Validation Error
Create a new event in a calendar. This allows creating meetings, appointments, and events with attendees, locations, recurrence patterns, and online meeting details.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Get the free/busy availability information for a collection of users, distribution lists, or resources (rooms or equipment) for a specified time period. Perfect for finding available meeting times and checking when people are free.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Optional request headers for customizing the response
Successful Response
Validation Error
Get a comprehensive list of all event objects across all calendars in the user's mailbox. This provides a unified view of all events from every calendar, supporting timezone preferences and OData query parameters for filtering, sorting, and pagination. Complements the specific calendar LIST_EVENTS function.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Query parameters for customizing the event list
Optional request headers for customizing the response
Successful Response
Validation Error
Create an event in the user's default calendar with simplified parameters. Perfect for quick event creation without specifying a calendar ID. Supports all event features including attendees, locations, recurrence patterns, and online meeting details.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Get the properties and relationships of a specific event. Returns event details including subject, body, attendees, location, start/end times, and all other event properties. Supports timezone preferences and custom property selection.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Query parameters for customizing the event response
Optional request headers for customizing the response
Successful Response
Validation Error
Get a set of event resources that have been added, deleted, or updated in a calendarView (a range of events defined by start and end dates) of the user's primary calendar. Supports delta query for incremental sync.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Query parameters for delta sync. Specify startDateTime and endDateTime for the initial call. Use $deltatoken or $skiptoken for subsequent calls.
Optional request headers for customizing the response
Successful Response
Validation Error
Forward a meeting event to new recipients. Allows the organizer or attendee to forward the meeting request, optionally including a comment. The new recipients will be added to the event and notified.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Accept the specified event in a user calendar. Optionally include a comment and choose whether to send a response to the organizer.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Request body for accepting the event.
Successful Response
Validation Error
Tentatively accept the specified event in a user calendar. Optionally include a comment, propose a new time, and choose whether to send a response to the organizer.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Request body for tentatively accepting the event.
Successful Response
Validation Error
Dismiss a reminder that has been triggered for an event in a user calendar.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Postpone a reminder for an event in a user calendar until a new time.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Get the instances (occurrences) of an event for a specified time range. If the event is a seriesMaster, returns the occurrences and exceptions in the range.
List of dot-notation field paths to include in the response. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use: Specify field paths using dot notation to include only those fields in the response. Supports nested fields (e.g., 'user.name', 'payload.headers'). When filtering lists, each item is filtered recursively. If a top-level field is specified without sub-fields, the entire value is included. If nested fields are specified, only those nested fields are included.
["id","name","status"]Filters to apply to response items. This is a post-processing filter that does not alter the data request nor the 3rd party response data.
How to use:
field_name: The field to filter on. Supports dot notation for nested fields (e.g., 'creator.age'). When filtering list items, this filters the items themselves. When usingroot, this filters elements within the array at therootpath.root: Optional path to an array of dictionaries. When set, filters the array elements at this path instead of filtering the items themselves. Use dot notation (e.g., 'payload.headers'). Important: Therootpath must target an array of dictionaries (the last array before filtering byfield_namevalue), andfield_nameshould be a field within those dictionary elements. In nested array structures,rootshould point to the final array of dictionaries that contain thefield_namefield. Otherwise no filtering will occur.
[{"field_name":"status","type":"string_list","values":["open","in_progress"]}]Successful Response
Validation Error
Last updated