{"_id":"5913986af865370f000b2d4b","__v":3,"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"},"parentDoc":null,"user":"5588b847f6c18d0d005bba01","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-10T22:47:06.141Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[]},"settings":"","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":"59139b903513940f0029c9f5","ref":"","in":"body","required":false,"desc":"The name of the meeting type displayed in the UI.","default":"","type":"string","name":"name"},{"_id":"59139b903513940f0029c9f4","ref":"","in":"body","required":false,"desc":"The length of the meeting type in minutes.","default":"","type":"int","name":"durationMin"},{"_id":"59139b903513940f0029c9f3","ref":"","in":"body","required":false,"desc":"The time window in which meetings of this type can be made.","default":"","type":"object","name":"daysFromNow"},{"_id":"59139b903513940f0029c9f2","ref":"","in":"body","required":false,"desc":"Minimum number of days from today to suggest meeting slots.","default":"","type":"int","name":"daysFromNow.start"},{"_id":"59139b903513940f0029c9f1","ref":"","in":"body","required":false,"desc":"Maximum number of days from today to suggest meeting slots.","default":"","type":"int","name":"daysFromNow.end"},{"_id":"59139b903513940f0029c9f0","ref":"","in":"body","required":false,"desc":"Availability configuration by weekday.","default":"","type":"object","name":"day[0-6]"},{"_id":"59139b903513940f0029c9ef","ref":"","in":"body","required":false,"desc":"Whether to allow meetings of this type to be booked on this day.","default":"","type":"boolean","name":"day[0,6].enabled"},{"_id":"59139b903513940f0029c9ee","ref":"","in":"body","required":false,"desc":"Whether to allow meetings of this type to be booked on this day.","default":"","type":"boolean","name":"day[1-5].enabled"},{"_id":"59139b903513940f0029c9ed","ref":"","in":"body","required":false,"desc":"Start time of period in which meetings of this type can be made. Format must match \"HH:mm:ss\".","default":"","type":"string","name":"day[0-6].startTime"},{"_id":"59139b903513940f0029c9ec","ref":"","in":"body","required":false,"desc":"End time of period in which meetings of this type can be made. Format must match \"HH:mm:ss\".","default":"","type":"string","name":"day[0-6].endTime"},{"_id":"599cb49f033797000fa2d20e","ref":"","in":"body","required":false,"desc":"The collection of timeslots for which you're available during this day. These timeslots cannot overlap, though `startTime`s and `endTime`s can match.","default":"","type":"array_object","name":"day[0-6].timeslots"},{"_id":"599cb49f033797000fa2d20d","ref":"","in":"body","required":false,"desc":"Start time of timeslot during which meetings of this type can be made. Format must match \"HH:mm:ss\".","default":"'09:00:00'","type":"string","name":"day[0-6].timeslots.startTime"},{"_id":"599cb49f033797000fa2d20c","ref":"","in":"body","required":false,"desc":"End time timeslot during which meetings of this type can be made. Format must match \"HH:mm:ss\".","default":"'17:00:00'","type":"string","name":"day[0-6].timeslots.endTime"},{"_id":"59139b903513940f0029c9eb","ref":"","in":"body","required":false,"desc":"Defaults to be used in the calendar invitation of meetings booked of this type.","default":"","type":"object","name":"defaults"},{"_id":"59139b903513940f0029c9ea","ref":"","in":"body","required":false,"desc":"The default calendar event title.","default":"","type":"string","name":"defaults.title"},{"_id":"59139b903513940f0029c9e9","ref":"","in":"body","required":false,"desc":"The default calendar event location.","default":"","type":"string","name":"defaults.location"},{"_id":"59139b903513940f0029c9e8","ref":"","in":"body","required":false,"desc":"The default calendar event description.","default":"","type":"string","name":"defaults.description"},{"_id":"59139b903513940f0029c9e7","ref":"","in":"body","required":false,"desc":"The URL slug to use for this meeting type's calendar.","default":"","type":"string","name":"link"},{"_id":"594830ff7947ca000f123258","ref":"","in":"body","required":false,"desc":"The amount of time in between meetings, must be in the range of 0 - 60.","default":"","type":"int","name":"buffer"},{"_id":"599cb49f033797000fa2d20b","ref":"","in":"body","required":false,"desc":"The Google Calendar IDs of the calendars on which meetings of this meeting type will be scheduled. If multiple calendars are added to a meeting type, meetings will be booked round-robin between those calendars.","default":"[<your primary calendar ID>]","type":"array_string","name":"calendarIds"},{"_id":"599cb49f033797000fa2d20a","ref":"","in":"body","required":false,"desc":"The round robin queue. Each element value is an index of a calendar ID in the meeting type's `calendarIds`. Calendars at the beginning of this queue will be preferred for booking when someone selects an available timeslot for this meeting type where multiple calendars have availability.","default":"[0]","type":"array_int","name":"roundRobinQueue"},{"_id":"599cb49f033797000fa2d209","ref":"","in":"body","required":false,"desc":"An array of default guests to be added to meetings of this type.","default":"[]","type":"array_object","name":"defaultGuests"},{"_id":"599cb49f033797000fa2d208","ref":"","in":"body","required":false,"desc":"The name of the default guest.","default":"","type":"string","name":"defaultGuests[].name"},{"_id":"599cb49f033797000fa2d207","ref":"","in":"body","required":false,"desc":"The email of the default guest.","default":"","type":"string","name":"defaultGuests[].email"},{"_id":"599cb49f033797000fa2d206","ref":"","in":"body","required":false,"desc":"Whether the default guest should be added as a required attendee of booked meetings of this type.","default":"","type":"boolean","name":"defaultGuests[].required"}],"url":"/v1/meetingtypes"},"isReference":true,"order":58,"body":"","excerpt":"Create a meeting type.","slug":"meetingtypes-1","type":"endpoint","title":"/meetingtypes"}

post/meetingtypes

Create a meeting type.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

userId:
string
The `_id` of the user who created the meeting type.
name:
string
The name of the meeting type displayed in the UI.
durationMin:
integer
The length of the meeting type in minutes.
daysFromNow:
object
The time window in which meetings of this type can be made.
daysFromNow.start:
integer
Minimum number of days from today to suggest meeting slots.
daysFromNow.end:
integer
Maximum number of days from today to suggest meeting slots.
day[0-6]:
object
Availability configuration by weekday.
day[0,6].enabled:
boolean
Whether to allow meetings of this type to be booked on this day.
day[1-5].enabled:
boolean
Whether to allow meetings of this type to be booked on this day.
day[0-6].startTime:
string
Start time of period in which meetings of this type can be made. Format must match "HH:mm:ss".
day[0-6].endTime:
string
End time of period in which meetings of this type can be made. Format must match "HH:mm:ss".
day[0-6].timeslots:
array of objects
The collection of timeslots for which you're available during this day. These timeslots cannot overlap, though `startTime`s and `endTime`s can match.
day[0-6].timeslots.startTime:
string'09:00:00'
Start time of timeslot during which meetings of this type can be made. Format must match "HH:mm:ss".
day[0-6].timeslots.endTime:
string'17:00:00'
End time timeslot during which meetings of this type can be made. Format must match "HH:mm:ss".
defaults:
object
Defaults to be used in the calendar invitation of meetings booked of this type.
defaults.title:
string
The default calendar event title.
defaults.location:
string
The default calendar event location.
defaults.description:
string
The default calendar event description.
link:
string
The URL slug to use for this meeting type's calendar.
buffer:
integer
The amount of time in between meetings, must be in the range of 0 - 60.
calendarIds:
array of strings[<your primary calendar ID>]
The Google Calendar IDs of the calendars on which meetings of this meeting type will be scheduled. If multiple calendars are added to a meeting type, meetings will be booked round-robin between those calendars.
roundRobinQueue:
array of integers[0]
The round robin queue. Each element value is an index of a calendar ID in the meeting type's `calendarIds`. Calendars at the beginning of this queue will be preferred for booking when someone selects an available timeslot for this meeting type where multiple calendars have availability.
defaultGuests:
array of objects[]
An array of default guests to be added to meetings of this type.
defaultGuests[].name:
string
The name of the default guest.
defaultGuests[].email:
string
The email of the default guest.
defaultGuests[].required:
boolean
Whether the default guest should be added as a required attendee of booked meetings of this type.

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 }}