/rooms

Set room logo

put

Upload room logo.

Path parameters

roomNamestringrequired

Room name.

Example: /room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd

Body

multipart/form-dataapplication/json

imagestring · binaryoptional

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' \
  --form 'image=binary'

multipart/form-dataapplication/json

204

401

429

204

No body

The logo was saved successfully.

Set room colors

put

Set primary, secondary and focus room colors.

Path parameters

roomNamestringrequired

Room name.

Example: /room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd

Body

tokensobjectoptional

Room colors defined in an object.

tokensPresetstring · enumoptional

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

Options: custom, default

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 '{
    "tokens": {
      "colors": {
        "primary": "text",
        "secondary": "text",
        "focus": "text"
      }
    },
    "tokensPreset": "custom"
  }'

204

401

429

204

No body

The tokens were saved successfully.

Set room background

put

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

Path parameters

roomNamestringrequired

Room name.

Example: /room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd

Body

multipart/form-dataapplication/json

imagestring · binaryoptional

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' \
  --form 'image=binary'

multipart/form-dataapplication/json

204

401

429

204

No body

The background image was saved successfully.

Set room knock page background

put

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

Path parameters

roomNamestringrequired

Room name.

Example: /room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd

Body

multipart/form-dataapplication/json

imagestring · binaryoptional

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' \
  --form 'image=binary'

multipart/form-dataapplication/json

204

401

429

204

No body

The knock page background image was saved successfully.