Skip to main content
POST
Create an Outlook calendar event as the calling member

Authorizations

x-api-key
string
header
required

Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.

Body

application/json
subject
string
required
Required string length: 1 - 255
start
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
end
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
body
string
Maximum string length: 20000
bodyContentType
enum<string>
default:text

How Outlook stores body: text (default) or html. Use html for links, line breaks, tables, or an HTML signature; markup sent as text shows as literal tags.

Available options:
text,
html
timeZone
string
default:UTC
Required string length: 1 - 100
location
string
Maximum string length: 255
attendees
string<email>[]
Maximum array length: 100
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,}$
confirmNotifications
boolean

Required when attendees are listed. Set true only when the user explicitly asked to invite them; Microsoft emails each attendee an invitation.

isOnlineMeeting
boolean

true makes this a Teams meeting with a join link in the invitation. Do not put "Microsoft Teams Meeting" in location instead; that is only text.

onlineMeetingProvider
enum<string>

Online meeting service; teamsForBusiness when omitted. Only with isOnlineMeeting: true.

Available options:
teamsForBusiness,
skypeForBusiness,
skypeForConsumer

Response

Outlook calendar event created.

ok
boolean
required
event
object
required
warning
string

Present when a Teams meeting was asked for but Microsoft returned no join link. The event exists; do not create it again.