/meetingtypes

post

https://api.mixmax.com/v1/meetingtypes

Creates a meeting type. The body must include every required field (see the schema), and userId must be you or someone in your workspace. Creating one also creates its reminder automation, as a paused rule. That rule is created before the body is checked, so a request rejected with 400 still leaves a paused rule behind.

The simplest way to build a valid body is to read one of your meeting types with GET /v1/meetingtypes/{id} and change its name and link.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The fields of a meeting type. Create needs all of them; update takes any subset.

name

string

required

link

string

required

The booking link's last part. Letters, numbers and URL-safe characters only.

durationMin

integer

required

Meeting length in minutes.

type

string

enum

required

Personal allows one calendar; Round Robin rotates between several.

Allowed:

calendarIds

array of strings

required

calendarIds*

daysFromNow

object

required

How far ahead people can book, as a start and end from 0 to 60, with a unit.

day0

object

required

Availability on one weekday, where day0 is Sunday.

day1

object

required

Availability on one weekday, where day0 is Sunday.

day2

object

required

Availability on one weekday, where day0 is Sunday.

day3

object

required

Availability on one weekday, where day0 is Sunday.

day4

object

required

Availability on one weekday, where day0 is Sunday.

day5

object

required

Availability on one weekday, where day0 is Sunday.

day6

object

required

Availability on one weekday, where day0 is Sunday.

buffer

integer

required

Minutes kept free around each meeting, 0 to 60.

minNoticeDuration

object

The minimum notice, as a value from 0 to 999 and a unit of minutes, hours, days or weekdays.

preventDoubleBooking

array of strings

required

Ids of more calendars to check for conflicts. Times busy on them are not offered.

preventDoubleBooking*

defaults

object

required

Default title, location and description for booked meetings.

defaultGuests

array of objects

required

defaultGuests*

customFields

array of objects

required

Extra questions on the booking page.

customFields*

roundRobinQueue

array of integers

required

The order in which a Round Robin meeting type rotates its calendars, as indexes into calendarIds. A calendar moves to the back after it gets a booking.

roundRobinQueue*

includeMessagePermaLink

boolean

required

guestsCanModifyInvites

boolean

required

roomsAndResources

array of objects

required

roomsAndResources*

anyRoomInBuilding

array of strings

required

Building ids. When set, Mixmax books any free room in the first building.

anyRoomInBuilding*

integrations

object

required

reducedInterval

boolean

required

ruleIds

array of strings

required

ruleIds*

useSpecificDates

boolean

true to offer times between the dates in setDateRange instead of daysFromNow.

setDateRange

object

With useSpecificDates, the first and last day people can book, in milliseconds since the epoch.

pageTitle

string

userId

string

required

Who the meeting type is for. Use your own _id.

Responses

403

userId is not in your workspace.

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json