{"_id":"5977d8ffee906b001fd5df07","project":"5588b8a2f6c18d0d005bba03","version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":15,"createdAt":"2015-06-23T01:38:42.696Z","releaseDate":"2015-06-23T01:38:42.696Z","categories":["5588b8a3f6c18d0d005bba07","5588e9689cfea70d00371df3","5588f5921163180d00b64704","561598b121e9110d0078025a","5616f1c9d170d00d00189306","5616f5c3a410c90d00c6121e","561803dcf8c9632100ac7592","563667280441020d0000e9eb","5642570d9417b40d00c0fcd3","57bf5f02efe0050e00d50bd5","57f53fb368a53b2000e03f0f","57f55187440418170086325a","582e3afa72fd270f0006926d","5841faa973967b0f004b4a2b","58db348aa32c8419002433bb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"57f53fb368a53b2000e03f0f","version":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API"},"user":"5588b847f6c18d0d005bba01","__v":1,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-25T23:49:19.856Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"method":"post","examples":{"codes":[]},"auth":"required","params":[{"_id":"59139b903513940f0029c9f6","ref":"","in":"body","required":false,"desc":"The `_id` of the user who created the meeting type.","default":"","type":"string","name":"userId"},{"_id":"5977db50177f8a001ffc80b6","ref":"","in":"body","required":false,"desc":"Timestamp represented in ms.","default":"","type":"double","name":"creationDate"},{"_id":"5977db50177f8a001ffc80b5","ref":"","in":"body","required":false,"desc":"The meeting location.","default":"","type":"string","name":"location"},{"_id":"5977db50177f8a001ffc80b4","ref":"","in":"body","required":false,"desc":"A description of the event.","default":"","type":"string","name":"description"},{"_id":"5977db50177f8a001ffc80b3","ref":"","in":"body","required":false,"desc":"The event's title on a calendar.","default":"","type":"string","name":"title"},{"_id":"5977db50177f8a001ffc80b2","ref":"","in":"body","required":false,"desc":"The timezone of the event, e.g. America/Los_Angeles","default":"","type":"string","name":"timezone"},{"_id":"5977db50177f8a001ffc80b1","ref":"","in":"body","required":false,"desc":"The name of the calendar the invite is on.","default":"","type":"string","name":"calendarName"},{"_id":"5977db50177f8a001ffc80b0","ref":"","in":"body","required":false,"desc":"The user's locale, e.g. 'en'","default":"","type":"string","name":"locale"},{"_id":"5977db50177f8a001ffc80af","ref":"","in":"body","required":false,"desc":"Whether invited guests can modify the event.","default":"","type":"boolean","name":"guestsCanModify"},{"_id":"5977db50177f8a001ffc80ae","ref":"","in":"body","required":false,"desc":"Array of timeslots specified by the meeting invite creator. Children have ISO dates 'start' and 'end'.","default":"","type":"array_object","name":"timeslots"},{"_id":"5977db50177f8a001ffc80ad","ref":"","in":"body","required":false,"desc":"Whether to allow double bookings.","default":"","type":"boolean","name":"allowDoubleBookings"},{"_id":"5977db50177f8a001ffc80ac","ref":"","in":"body","required":false,"desc":"Array of guests to add to the calendar event as ‘accepted’ once the event is created. Guest objects have 'name' and 'email'.","default":"","type":"array_object","name":"additionalGuests"},{"_id":"5977db50177f8a001ffc80ab","ref":"","in":"body","required":false,"desc":"The ID of the meetingType the invite was created from.","default":"","type":"string","name":"meetingTypeId"}],"url":"/v1/meetinginvites"},"isReference":true,"order":56,"body":"","excerpt":"Create a meeting invite.","slug":"meetinginvites","type":"endpoint","title":"/meetinginvites"}

post/meetinginvites

Create a meeting invite.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

userId:
string
The `_id` of the user who created the meeting type.
creationDate:
double
Timestamp represented in ms.
location:
string
The meeting location.
description:
string
A description of the event.
title:
string
The event's title on a calendar.
timezone:
string
The timezone of the event, e.g. America/Los_Angeles
calendarName:
string
The name of the calendar the invite is on.
locale:
string
The user's locale, e.g. 'en'
guestsCanModify:
boolean
Whether invited guests can modify the event.
timeslots:
array of objects
Array of timeslots specified by the meeting invite creator. Children have ISO dates 'start' and 'end'.
allowDoubleBookings:
boolean
Whether to allow double bookings.
additionalGuests:
array of objects
Array of guests to add to the calendar event as ‘accepted’ once the event is created. Guest objects have 'name' and 'email'.
meetingTypeId:
string
The ID of the meetingType the invite was created from.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}