Sign in
latestOpenAPI 3.0.02026-08-1027587.8 KB

3d9aec0774ff

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

roomNamestring required

Room name.

Request body

palette'default' | 'grey' | 'purple' | 'burgund'

Knock page background color name. ['default', 'grey', 'purple', 'burgund']

theme'default' | 'mountains' | 'characters' | 'rocks'

Knock page background image. ['default', 'mountains', 'characters', 'rocks']

Response

The knock page background image was saved successfully.