Skip to content

Create wallpaper
Stable

Request

Uploads a new wallpaper image to the enterprise. The image is submitted as a multipart/form-data request and, once uploaded, can be referenced by wallpaper_id in Windows blueprint homescreen and lock screen settings. There is no dedicated wallpaper library in the console. Wallpapers are only visible by previewing their associated blueprint.

Request body (multipart/form-data)

image_file (required) — The image file to upload

orientation (required) — Orientation of the image (e.g., landscape)

Common Use Cases

Adding a new branded wallpaper before assigning it to a blueprint

Programmatically uploading wallpapers as part of an enterprise onboarding or branding

Workflow

Replacing an outdated wallpaper by uploading a new version and updating blueprint references to point to the new wallpaper_id

Best Practices

Store the wallpaper_id UUID from the response — it is required to reference the wallpaper in a blueprint homescreen and lock screen settings

Since wallpapers are not browsable in the Console, use GET /v1/enterprise/{enterprise_id}/wallpaper/ to audit what has been uploaded and avoid creating duplicates

Specify orientation accurately at upload time — this metadata cannot be changed after upload; upload a new image if the orientation needs to be corrected

Verify a wallpaper is not referenced in any active blueprint before deleting it, as there is no Console warning to flag active references

Security
esper_cloud_api_apiKey
Path
enterprise_idstringrequired

A UUID string identifying this enterprise.

Bodymultipart/form-datarequired
image_filestring, (path)required

Valid file to upload

orientationstringrequired

Orientation of image e.g. landscape

cURL
curl -i -X POST \
  'https://api.esper.io/_mock/openapi/v1/enterprise/{enterprise_id}/wallpaper/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F image_file=string \
  -F orientation=string

Responses

Successful Operation

Bodyapplication/json
idstring, (uuid)
enterprisestring, (uuid)
image_filestring, (url)
thumbnailstring, (url)
orientationstring
is_activeboolean
created_onstring, (date-time)
updated_onstring, (date-time)
Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9", "image_file": "string", "thumbnail": "string", "orientation": "string", "is_active": true, "created_on": "2019-08-24T14:15:22Z", "updated_on": "2019-08-24T14:15:22Z" }