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

Request

Base URL
https://api.whereby.dev/v1
Auth
none declared
TypeScript
https://skmtc.dev/whereby/apis/whereby-rest-api/docs/rooms/:roomName/theme/room-knock-page-background/put.ts
A function with typed inputs. Its response is checked against the schema.

roomNamestring required

Room name.

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']

The knock page background image was saved successfully.

No recorded changes to this operation across all 1 revision of this API.