Update event with the Outlook Calendar API

Changes an event and returns it. Only the fields sent change. On a meeting the user organizes, Outlook emails the change to the attendees. Do not send a new body for an online meeting: the join details live in the body and would be lost.

Identifier
outlook_calendar_update_event

The request

POST https://connect.reportei.com/api/tools/outlook_calendar_update_event/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "event_id": "<event_id>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
event_idstringYesEvent id from List events. The id of an occurrence acts on that occurrence; its seriesMasterId acts on the whole series.
subjectstringNoTitle of the event.
bodyobjectNoDescription of the event. contentType is text or html.
startobjectNoWhen the event starts. An all-day event starts at midnight.
endobjectNoWhen the event ends. An all-day event ends at midnight of the next day, in the same time zone as start.
isAllDaybooleanNotrue for an all-day event, with start and end at midnight.
locationobjectNoWhere the event happens.
attendeesarrayNoPeople, rooms or equipment invited. Outlook emails them the invitation.
isOnlineMeetingbooleanNotrue adds an online meeting, together with onlineMeetingProvider.
onlineMeetingProviderstringNoteamsForBusiness adds a Microsoft Teams link. It needs a work or school account.Values: teamsForBusiness
showAsstringNoHow the time shows in the calendar. oof is out of office.Values: free, tentative, busy, oof, workingElsewhere
importancestringNoImportance of the event.Values: low, normal, high
sensitivitystringNoPrivacy of the event.Values: normal, personal, private, confidential
isReminderOnbooleanNotrue sets a reminder.
reminderMinutesBeforeStartintegerNoMinutes before the start that the reminder shows.
categoriesarrayNoCategory names of the user. The list replaces the current one.
recurrenceobjectNoRepetition. Besides type and interval, pattern needs: weekly, daysOfWeek and firstDayOfWeek; absoluteMonthly, dayOfMonth; relativeMonthly, daysOfWeek; absoluteYearly, dayOfMonth and month; relativeYearly, daysOfWeek and month. range.startDate is the date of start; range.type endDate needs endDate, and numbered needs numberOfOccurrences.
allowNewTimeProposalsbooleanNofalse stops invitees from proposing another time. The default is true.
responseRequestedbooleanNofalse asks invitees for no response. The default is true.

Supported connections

Your customer connects their Outlook Calendar account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/outlook_calendar, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/outlook_calendar_update_event. It becomes your agent's tool definition with no conversion.

Other Outlook Calendar tools

See all 10 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.