/rooms

Set room logo

Upload room logo.

put

/rooms/{roomName}/theme/logo

Path parameters

roomNameanyrequired

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.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.whereby.dev/v1/rooms/{roomName}/theme/logo' \
  --header 'Content-Type: multipart/form-data'

204

401

429

204

No body

The logo was saved successfully.

Set room colors

Set primary, secondary and focus room colors.

put

/rooms/{roomName}/theme/tokens

Path parameters

roomNameanyrequired

Room name.

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

Body

tokensPresetstring · enum

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

Options: custom, default

tokensobject

Room colors defined in an object.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.whereby.dev/v1/rooms/{roomName}/theme/tokens' \
  --header 'Content-Type: application/json' \
  --data '{"tokensPreset":"custom","tokens":{"colors":{}}}'

204

401

429

204

No body

The tokens were saved successfully.

Set room background

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

put

/rooms/{roomName}/theme/room-background

Path parameters

roomNameanyrequired

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).

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.whereby.dev/v1/rooms/{roomName}/theme/room-background' \
  --header 'Content-Type: multipart/form-data'

204

401

429

204

No body

The background image was saved successfully.

Set room knock page background

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

put

/rooms/{roomName}/theme/room-knock-page-background

Path parameters

roomNameanyrequired

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).

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.whereby.dev/v1/rooms/{roomName}/theme/room-knock-page-background' \
  --header 'Content-Type: multipart/form-data'

204

401

429

204

No body

The knock page background image was saved successfully.