---
title: "Set room knock page background"
method: PUT
path: "/rooms/{roomName}/theme/room-knock-page-background"
---

# Set room knock page background

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

## Request

- Base URL: `https://api.whereby.dev/v1`
- URL: `https://api.whereby.dev/v1/rooms/{roomName}/theme/room-knock-page-background`
- 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)

Use [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData/append) to upload a custom knock background image. JSON objects can be used to set Whereby provided defaults.

## Path parameters

- `roomName` string, required

## Request body

- object: Set a pre-defined knock page background color and image.
  - `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 `204`

The knock page background image was saved successfully.

## Other responses

- `401`: Access token is missing or invalid
- `429`: You are rate limited

---

[API](https://skmtc.dev/whereby/apis/whereby-rest-api.md) - [All operations](https://skmtc.dev/whereby/apis/whereby-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/whereby/apis/whereby-rest-api/revisions/3d9aec0774ff?raw)