POST Upload a custom preview image
POST /viewers/{viewerToken}/preview: Upload a custom preview image. Stores the uploaded image as custom preview of the viewer. A custom preview is marked as
Are you an LLM? You can read better optimized documentation at /docs/api/endpoints/viewers/post-viewers-viewerToken-preview.md for this page in Markdown format
POST
Try it out https://api.rooom.com/viewers/{viewerToken}/previewScopes
viewer:writeParameters
Path Parameters
| Name | Type | Description |
|---|---|---|
viewerTokenrequiredExample: _viewerToken_ | string | Viewer token. |
Body
multipart/form-data| Name | Type | Description |
|---|---|---|
previewrequired | file | Preview image (jpg or png, max. 10MB) |
Responses
200Custom preview stored successfully
400No or invalid preview image received
401Unauthorized
404Viewer not found
500Custom preview upload failed
POST /viewers/{viewerToken}/preview Upload a custom preview image Stores the uploaded image as custom preview of the viewer. A custom preview is marked as overwritten and is not replaced by an automatically generated preview anymore. Required scopes: viewer:write viewerToken Viewer token. preview Preview image (jpg or png, max. 10MB)