Sign in
latestOpenAPI 3.0.02026-08-1027587.8 KB

3d9aec0774ff

Create meeting

Creates a transient room that is available between creation and an hour after the given end date. After this time the room will be automatically deleted. The URL to this room is present in the response.

post/meetings

Request body

endDatestring date-time required

When the meeting ends. By default in UTC but a timezone can be specified, e.g. 2025-05-07T17:42:49-05:00. This has to be the same or after the current date.

startDatestring date-time

(DEPRECATED - value is ignored) Start time now defaults to time of request

isLockedboolean

The initial lock state of the room. If true, only hosts will be able to let in other participants and change lock state.

roomMode'group' | 'normal'

The mode and size of the created transient room. normal is the default room mode and should be used for meetings up to 4 participants. group should be used for meetings that require more than 4 participants.

roomNamePrefixstring

This will be used as the prefix for the room name. The string should be lowercase, and spaces will be automatically removed. 39 character max

roomNamePattern'uuid' | 'human-short'

The format of the randomly generated room name. uuid is the default room name pattern and follows the usual 8-4-4-4-12 pattern. human-short generates a shorter string made up of six distinguishable characters.

templateType'viewerMode'

If provided, the room will be created with the given template type. Each template defines a set of properties needed for a particular use-case. Currently the only supported template type is "viewerMode". This will set up a room with properties that are needed to create a viewer mode room. The room will be locked, roomMode set to "group" and fields like hostRoomUrl and viewerRoomUrl will be added to the response.

fieldsstring[]

Additional fields that should be populated.

  • hostRoomUrl - Include hostRoomUrl field in the meeting response.
  • viewerRoomUrl - Include viewerRoomUrl field in the meeting response.

Example request

{
  "roomMode": "group",
  "roomNamePrefix": "example-prefix",
  "roomNamePattern": "uuid"
}

Response

The resource was created successfully.

meetingIdstring required

The ID of the meeting.

roomNamestring

The name of the room.

roomUrlstring uri required

The URL to room where the meeting will be hosted.

startDatestring date-time

When the meeting starts. Always in UTC, regardless of the input timezone.

endDatestring date-time required

When the meeting ends. Always in UTC, regardless of the input timezone.

hostRoomUrlstring uri

The URL to the room where the meeting will be hosted which will also make the user the host of the meeting. A host will get additional privileges like locking the room, and removing and muting participants, so you should be careful with whom you share this URL. The user will only become a host if the meeting is on-going (some additional slack is added to allow a host joining the meeting ahead of time or if the meeting goes over time). This field is optional and will only be returned if requested through the fields parameter.

viewerRoomUrlstring uri

The URL to the room where the meeting will be hosted which will make the user a viewer of the meeting. A viewer will not be able to turn on the camera or microphone, but will be able to join the meeting. This field is optional and will only be returned if requested through the fields parameter.

Example response

{
  "meetingId": "9cf691bf-f2d5-4420-bda9-ee8607bb558b",
  "startDate": "2025-05-12T16:42:49Z",
  "endDate": "2025-05-12T17:42:49Z",
  "roomUrl": "https://subdomain.whereby.com/room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd"
}