REST API Reference

Versioning

As our API continues to evolve it will be versioned to ensure backward compatibility for our users. Breaking changes will come under new major versions, while non-breaking changes may be added to existing versions and change more frequently.

Breaking changes:

• Removal of endpoints

• Removing response data

• Changes in request / response format

• Changes to authentication mechanism

Non-breaking changes:

• Adding new endpoints

• Adding to response data

• New parameters

Rate Limiting (throttling)

We rate limit our APIs, returning a 429 status code response when your request has been throttled. You will have to wait and retry the request later.

We use a point system to limit the number of requests that you can make. A read request consumes 1 point, a delete consumes 2 points and a write request consumes 3 points. Here are some examples of how a 1000 point budget could be spent within 1 minute:

• 1000 GET requests (1000 x 1 = 1000 points)

• 500 DELETE requests (500 x 2 = 1000 points)

• 333 POST requests (333 x 3 = 999 points)

• 200 DELETE + 100 POST + 300 GET requests (200 x 2 + 100 x 3 + 300 x 1 = 1000 points)

Grow plans have 1000 points in total per minute, and Build plans have 100. The limits are global and are shared across all your API keys. Talk to us if you need higher limits.

You may read the Retry-After (seconds) or X-RateLimit-Reset (date) response headers in order to know when you can restart your requests. In addition, the X-RateLimit-Limit header includes the total number of points for your organization, and the X-RateLimit-Remaining header displays the remaining available points.

Authentication

BearerAuth

The bearer token will be provided upon request and it is up to the client to keep it secret. Every API call needs to contain this token in order to authenticate and authorize the client.

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

/meetings

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

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.

POSThttps://api.whereby.dev/v1/meetings

Body

application/json

Meeting to add.

endDate*string (date-time)

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

isLockedboolean

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

roomModeenum

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.

groupnormal

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

roomNamePatternenum

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.

uuidhuman-short

templateTypeenum

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.

viewerMode

recordingobject

Options for how a meeting should be recorded.

streamingobject

A configuration object for live RTMP streaming of the meeting

fieldsFields (array of enum)

Additional fields that should be populated.

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

Response

201401403429

The resource was created successfully.

Body

application/json

meetingId*string

The ID of the meeting.

roomNamestring

The name of the room.

roomUrl*string (uri)

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.

endDate*string (date-time)

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.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/meetings', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "endDate": "2024-04-27T15:33:50.261Z"
    }),
});
const data = await response.json();

Response

{
  "meetingId": "1",
  "startDate": "2020-05-12T16:42:49Z",
  "endDate": "2020-05-12T17:42:49Z",
  "roomUrl": "https://subdomain.whereby.com/dda1beca-af37-11eb-ac88-372b6869f077"
}

Get meetings

Returns a list of meetings.

GEThttps://api.whereby.dev/v1/meetings

Query parameters

Response

200401404429

A JSON object with the page containing the array with the meetings results.

Body

application/json

results*array of Meeting (object)

cursor*string

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request. If there are no more results, the value returned is null.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/meetings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "results": [
    {
      "meetingId": "1",
      "startDate": "2020-05-12T16:42:49Z",
      "endDate": "2020-05-12T17:42:49Z",
      "roomUrl": "https://subdomain.whereby.com/dda1beca-af37-11eb-ac88-372b6869f077"
    }
  ],
  "cursor": "text"
}

Get meeting

Returns the specified meeting.

GEThttps://api.whereby.dev/v1/meetings/{meetingId}

Path parameters

meetingId*any

meeting ID.

Query parameters

Response

200401404429

A JSON object representing the meeting.

Body

application/json

meetingId*string

The ID of the meeting.

roomNamestring

The name of the room.

roomUrl*string (uri)

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.

endDate*string (date-time)

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.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/meetings/{meetingId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "meetingId": "1",
  "startDate": "2020-05-12T16:42:49Z",
  "endDate": "2020-05-12T17:42:49Z",
  "roomUrl": "https://subdomain.whereby.com/dda1beca-af37-11eb-ac88-372b6869f077"
}

Delete meeting

Deletes the specified meeting. The endpoint is idempotent, meaning it will return the same response even if the meeting has already been deleted.

DELETEhttps://api.whereby.dev/v1/meetings/{meetingId}

Path parameters

meetingId*any

meeting ID.

Response

204401429

The resource was deleted successfully.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/meetings/{meetingId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

/insights

Get room insights

Gets a summary of insights collected for rooms.

GEThttps://api.whereby.dev/v1/insights/rooms

Query parameters

Response

200401429

Array of sorted rooms with their insights.

Body

application/json

cursorstring

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request. If there are no more results, the value returned is null.

resultsarray of object

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/insights/rooms', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "cursor": "text",
  "results": [
    {
      "roomName": "/4b3bd908-cb88-11ec-9d64-0242ac120002",
      "createdAt": "2020-01-01T00:00:00.000Z",
      "endAt": "2020-01-01T01:00:00.000Z",
      "firstSessionStartedAt": "2020-01-01T00:15:00.000Z",
      "lastSessionStartedAt": "2020-01-01T00:45:00.000Z",
      "totalParticipantMinutes": 124,
      "totalRecorderMinutes": 120,
      "totalStreamerMinutes": 120,
      "totalUniqueParticipants": 4,
      "totalUniqueRecorders": 2,
      "totalUniqueStreamers": 1,
      "totalSessions": 2
    }
  ]
}

Get room session insights

Gets a summary of usage for each session of a given room.

GEThttps://api.whereby.dev/v1/insights/room-sessions

Query parameters

Response

200401429

Array of sorted sessions with their insights.

Body

application/json

cursorstring

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request. If there are no more results, the value returned is null.

resultsarray of object

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/insights/room-sessions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "cursor": "text",
  "results": [
    {
      "roomSessionId": "32ba120a-a691-4e8e-aec3-a610239271de",
      "roomName": "/4b3bd908-cb88-11ec-9d64-0242ac120002",
      "startedAt": "2020-01-01T00:00:00.000Z",
      "endedAt": "2020-01-01T01:00:00.000Z",
      "totalParticipantMinutes": 124,
      "totalRecorderMinutes": 120,
      "totalStreamerMinutes": 120,
      "totalUniqueParticipants": 4,
      "totalUniqueRecorders": 3,
      "totalUniqueStreamers": 2
    }
  ]
}

Get participants

Gets a list of participants, by either a given session id or external id.

GEThttps://api.whereby.dev/v1/insights/participants

Query parameters

Response

200401429

Array of sorted sessions participants with insights.

Body

application/json

cursorstring

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request. If there are no more results, the value returned is null.

resultsarray of object

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/insights/participants', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "cursor": "text",
  "results": [
    {
      "roomSessionId": "32ba120a-a691-4e8e-aec3-a610239271de",
      "participantId": "/4b3bd908-cb88-11ec-9d64-0242ac120002",
      "deviceId": "text",
      "userId": "32ba120a-a691-4e8e-aec3-a610239271de",
      "roleName": "granted_visited",
      "displayName": "John Doe",
      "joinedAt": "2020-01-01T00:00:00.000Z",
      "leftAt": "2020-01-01T01:00:00.000Z",
      "externalId": "text"
    }
  ]
}

Get details for a participant in a session

Returns session data such as user agent, bandwidth and packet loss for the participant.

GEThttps://api.whereby.dev/v1/insights/participant

Query parameters

Response

200401429

Array of sorted sessions participants with insights.

Body

application/json

displayName*string

Display name of the participant.

userRole*string

The role of the participant.

userAgent*string

User agent string of the participant.

timeStamp*string

Timestamp the participant joined the session.

sampleRateMs*number

The interval (in milliseconds) the samples are collected in.

samples*object

Data object arrays with network data. packetLossSend, packetLossRecv, bitrateSend and bitrateRecv.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/insights/participant', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "displayName": "text",
    "userRole": "host",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36",
    "timeStamp": "text",
    "sampleRateMs": 2000
  }
]

/recordings

Get recordings

Returns the recordings.

GEThttps://api.whereby.dev/v1/recordings

Query parameters

Response

200401404429

A JSON object with the page containing the array with the recordings results.

Body

application/json

results*array of Recording (object)

cursor*string

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request. If there are no more results, the value returned is null.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/recordings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "results": [
    {
      "recordingId": "1",
      "roomSessionId": "1",
      "filename": "recording.mp4",
      "startDate": "2020-01-01T00:00:00.000Z",
      "endDate": "2020-01-01T00:00:00.000Z",
      "sizeInMegaBytes": 100
    }
  ],
  "cursor": "text"
}

Get recording

Returns the specified recording.

GEThttps://api.whereby.dev/v1/recordings/{recordingId}

Path parameters

recordingId*any

The recording ID.

Response

200401404429

A JSON object representing the recording.

Body

application/json

Recording (object)

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/recordings/{recordingId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "recordingId": "1",
  "roomSessionId": "1",
  "filename": "recording.mp4",
  "startDate": "2020-01-01T00:00:00.000Z",
  "endDate": "2020-01-01T00:00:00.000Z",
  "sizeInMegaBytes": 100
}

Get recording access link

Returns the access link for the specified recording.

GEThttps://api.whereby.dev/v1/recordings/{recordingId}/access-link

Path parameters

recordingId*any

Recording ID.

Query parameters

Response

200401404429

A JSON object representing the access link.

Body

application/json

accessLink*string

The access link.

expires*integer

The timestamp when the access link expires.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/recordings/{recordingId}/access-link', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "accessLink": "https://s3.eu-central-1.amazonaws.com/recordings/1.mp4?AWSAccessKeyId=AKIAJ...",
  "expires": 1588262400000
}

Delete recording

Deletes the specified recording. The endpoint is idempotent, meaning it will return the same response even if the recording has already been deleted.

DELETEhttps://api.whereby.dev/v1/recordings/{recordingId}

Path parameters

recordingId*any

Recording ID.

Response

204401429

The resource was deleted successfully.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/recordings/{recordingId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Bulk delete recordings

Deletes multiple recordings at once. This is an asynchronous operation. The endpoint returns immediately, and schedules a background job to delete the recordings. The endpoint is idempotent, meaning it will return the same response even if the recordings have already been deleted, or the recordings doesn't exist.

POSThttps://api.whereby.dev/v1/recordings/bulk-delete

Body

application/json

recordingIds*array of string

Response

204401429

The resources are scheduled for deletion.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/recordings/bulk-delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "recordingIds": [
        "1"
      ]
    }),
});
const data = await response.json();

/transcriptions

Create transcription

Creates a new transcription for the specified recording.

POSThttps://api.whereby.dev/v1/transcriptions

Path parameters

recordingId*any

Recording ID.

Body

application/json

recordingId*string

The recording ID for which the transcription should be created.

Response

201401404429

The transcription job was scheduled successfully.

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/transcriptions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "recordingId": "1"
    }),
});
const data = await response.json();

Get transcriptions

Returns a list of transcriptions

GEThttps://api.whereby.dev/v1/transcriptions

Query parameters

Response

200401429

A JSON array representing the transcriptions.

Body

application/json

results*array of Transcription (object)

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/transcriptions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "results": [
    {
      "transcriptionId": "1",
      "roomSessionId": "1",
      "filename": "transcription.md",
      "roomName": "room-name",
      "startDate": "2020-01-01T00:00:00.000Z",
      "endDate": "2020-01-01T00:00:00.000Z",
      "state": "completed",
      "createdAt": "2020-01-01T00:00:00.000Z"
    }
  ]
}

Get transcription

Returns the specified transcription metadata.

GEThttps://api.whereby.dev/v1/transcriptions/{transcriptionId}

Path parameters

transcriptionId*any

Transcription ID.

Response

200401404429

A JSON object representing the transcription.

Body

application/json

Transcription (object)

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/transcriptions/{transcriptionId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "transcriptionId": "1",
  "roomSessionId": "1",
  "filename": "transcription.md",
  "roomName": "room-name",
  "startDate": "2020-01-01T00:00:00.000Z",
  "endDate": "2020-01-01T00:00:00.000Z",
  "state": "completed",
  "createdAt": "2020-01-01T00:00:00.000Z"
}

Get transcription access link

Returns the access link for the specified transcription.

GEThttps://api.whereby.dev/v1/transcriptions/{transcriptionId}/access-link

Path parameters

transcriptionId*any

Transcription ID.

Query parameters

Response

200401404429

A JSON object representing the access link.

Body

application/json

accessLink*string

The access link.

expires*integer

The timestamp when the access link expires.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/transcriptions/{transcriptionId}/access-link', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "accessLink": "https://s3.eu-central-1.amazonaws.com/recordings/1.mp4?AWSAccessKeyId=AKIAJ...",
  "expires": 1588262400000
}

Delete transcription

Deletes the specified transcription. The endpoint is idempotent, meaning it will return the same response even if the transcription has already been deleted.

DELETEhttps://api.whereby.dev/v1/transcriptions/{transcriptionId}

Path parameters

transcriptionId*any

Transcription ID.

Response

204401429

The resource was deleted successfully.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/transcriptions/{transcriptionId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Bulk delete transcriptions

Deletes multiple transcriptions at once. This is an asynchronous operation. The endpoint returns immediately, and schedules a background job to delete the transcriptions. The endpoint is idempotent, meaning it will return the same response even if the transcriptions have already been deleted, or the transcriptions doesn't exist.

POSThttps://api.whereby.dev/v1/transcriptions/bulk-delete

Body

application/json

transcriptionIds*array of string

Response

204401429

The resources are scheduled for deletion.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/transcriptions/bulk-delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "transcriptionIds": [
        "1"
      ]
    }),
});
const data = await response.json();

/summaries

Get summaries

Returns a list of summaries

Session summaries are currently in Beta and available to selected customers only. Email us at [e-mail] to join our pilot program (terms and conditions apply).

GEThttps://api.whereby.dev/v1/summaries

Query parameters

Response

200401429

A JSON array representing the summaries.

Body

application/json

results*array of Summary (object)

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/summaries', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "results": [
    {
      "summaryId": "1",
      "transcriptionId": "1",
      "summary": {
        "summary": "This is a meeting summary"
      },
      "roomSessionId": "1",
      "roomName": "room-name",
      "startDate": "2020-01-01T00:00:00.000Z",
      "endDate": "2020-01-01T00:00:00.000Z",
      "state": "completed",
      "createdAt": "2020-01-01T00:00:00.000Z",
      "modifiedAt": "2020-01-01T00:00:00.000Z",
      "template": "General Narrative"
    }
  ]
}

Create summary

Creates a new summary for the specified transcription.

Session summaries are currently in Beta and available to selected customers only. Email us at [e-mail] to join our pilot program (terms and conditions apply).

POSThttps://api.whereby.dev/v1/summaries

Path parameters

transcriptionId*any

Transcription ID.

Body

application/json

transcriptionId*string

The transcription ID for which the summary should be created.

templateenum

The template that the summary should be created from. The following summary templates are currently available:

• General Bulleted
• General Narrative
• SOAP
• Extended SOAP
• General Narrative
• Educational Lecture
• Educational Tutoring

SOAPExtended SOAPGeneral NarrativeGeneral BulletedEducational LectureEducational Tutoring

Response

201401404429

The summary job was scheduled successfully.

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/summaries', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "transcriptionId": "1"
    }),
});
const data = await response.json();

Get summary

Returns the specified summary.

Session summaries are currently in Beta and available to selected customers only. Email us at [e-mail] to join our pilot program (terms and conditions apply).

GEThttps://api.whereby.dev/v1/summaries/{summaryId}

Path parameters

summaryId*any

Summary ID.

Response

200401404429

A JSON object representing the summary.

Body

application/json

Summary (object)

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/summaries/{summaryId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "summaryId": "1",
  "transcriptionId": "1",
  "summary": {
    "summary": "This is a meeting summary"
  },
  "roomSessionId": "1",
  "roomName": "room-name",
  "startDate": "2020-01-01T00:00:00.000Z",
  "endDate": "2020-01-01T00:00:00.000Z",
  "state": "completed",
  "createdAt": "2020-01-01T00:00:00.000Z",
  "modifiedAt": "2020-01-01T00:00:00.000Z",
  "template": "General Narrative"
}

Delete summary

Deletes the specified summary. The endpoint is idempotent, meaning it will return the same response even if the summary has already been deleted.

Session summaries are currently in Beta and available to selected customers only. Email us at [e-mail] to join our pilot program (terms and conditions apply).

DELETEhttps://api.whereby.dev/v1/summaries/{summaryId}

Path parameters

summaryId*any

Summary ID.

Response

204401429

The resource was deleted successfully.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/summaries/{summaryId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

/rooms

Set room logo

Upload room logo.

PUThttps://api.whereby.dev/v1/rooms/{roomName}/theme/logo

Path parameters

roomName*any

Room name.

Body

multipart/form-dataapplication/json

imagestring (binary)

The logo image. We recommend PNG images at least 400px wide.

Response

204401429

The logo was saved successfully.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/rooms/{roomName}/theme/logo', {
    method: 'PUT',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Set room colors

Set primary and secondary room colors.

PUThttps://api.whereby.dev/v1/rooms/{roomName}/theme/tokens

Path parameters

roomName*any

Room name.

Body

application/json

tokensobject

Room colors defined in an object.

tokensPresetenum

Use the given primary or secondary colors when custom. Use organization defaults when default or not defined.

customdefault

Response

204401429

The tokens were saved successfully.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/rooms/{roomName}/theme/tokens', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Set room background

Use FormData to upload a custom background image. JSON objects can be used to set Whereby provided defaults.

PUThttps://api.whereby.dev/v1/rooms/{roomName}/theme/room-background

Path parameters

roomName*any

Room name.

Body

multipart/form-dataapplication/json

imagestring (binary)

The background image. We recommend PNG images at least 1400px wide (max 600 kb).

Response

204401429

The background image was saved successfully.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/rooms/{roomName}/theme/room-background', {
    method: 'PUT',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Set room knock page background

Use FormData to upload a custom knock background image. JSON objects can be used to set Whereby provided defaults.

PUThttps://api.whereby.dev/v1/rooms/{roomName}/theme/room-knock-page-background

Path parameters

roomName*any

Room name.

Body

multipart/form-dataapplication/json

imagestring (binary)

The knock page background image. We recommend PNG images at least 1400px wide (max 600 kb).

Response

204401429

The knock page background image was saved successfully.

Request

JavaScriptCurl

const response = await fetch('https://api.whereby.dev/v1/rooms/{roomName}/theme/room-knock-page-background', {
    method: 'PUT',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();