/rooms

Set room logo

Upload room logo.

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

Path parameters

roomName*any

Room name.

Example: "913c4449-c904-4313-b560-ae5bf0b04a39"

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

JavaScriptCurlPython

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();

Response

429

{
  "error": "Rate limit active for throttle key: organization:1",
  "data": {
    "msLeft": 38689
  }
}

Set room colors

Set primary, secondary and focus room colors.

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

Path parameters

roomName*any

Room name.

Example: "913c4449-c904-4313-b560-ae5bf0b04a39"

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

JavaScriptCurlPython

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();

Response

429

{
  "error": "Rate limit active for throttle key: organization:1",
  "data": {
    "msLeft": 38689
  }
}

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.

Example: "913c4449-c904-4313-b560-ae5bf0b04a39"

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

JavaScriptCurlPython

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();

Response

429

{
  "error": "Rate limit active for throttle key: organization:1",
  "data": {
    "msLeft": 38689
  }
}

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.

Example: "913c4449-c904-4313-b560-ae5bf0b04a39"

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

JavaScriptCurlPython

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();

Response

429

{
  "error": "Rate limit active for throttle key: organization:1",
  "data": {
    "msLeft": 38689
  }
}