Status

/rooms

put

Upload room logo.

Path parameters
roomNamestringRequired

Room name.

Example: /room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd
Body
imagestring · binaryOptional

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

Responses
204

The logo was saved successfully.

put
PUT /v1/rooms/{roomName}/theme/logo HTTP/1.1
Host: api.whereby.dev
Content-Type: multipart/form-data
Accept: */*
Content-Length: 18

{
  "image": "binary"
}
No content

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
tokensPresetstring · enumOptional

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

Possible values:
Responses
204

The tokens were saved successfully.

put
PUT /v1/rooms/{roomName}/theme/tokens HTTP/1.1
Host: api.whereby.dev
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "tokens": {
    "colors": {
      "primary": "text",
      "secondary": "text",
      "focus": "text"
    }
  },
  "tokensPreset": "custom"
}
No content

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

Set a custom image as background.

imagestring · binaryOptional

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

Responses
204

The background image was saved successfully.

put
PUT /v1/rooms/{roomName}/theme/room-background HTTP/1.1
Host: api.whereby.dev
Content-Type: multipart/form-data
Accept: */*
Content-Length: 18

{
  "image": "binary"
}
No content

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

Set a custom image as knock page background.

imagestring · binaryOptional

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

Responses
204

The knock page background image was saved successfully.

put
PUT /v1/rooms/{roomName}/theme/room-knock-page-background HTTP/1.1
Host: api.whereby.dev
Content-Type: multipart/form-data
Accept: */*
Content-Length: 18

{
  "image": "binary"
}
No content

Last updated

Was this helpful?