HomeGuidesAPI Reference
API Reference

Upload a new custom brand image

Uploads a custom image for the specified brand customization type. The image is stored in the database and applied to both legacy and React UIs. Requires READ_WRITE permission. Logs the upload action to the system audit log.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

The image customization type to upload. Determines where the image will be displayed in the UI.

Allowed:
string
required
length ≤ 30
^[^/\\]+\.(jpg|jpeg|gif|png|icns|ico)$

The file name for the uploaded image. Max 30 characters. Must have a valid image extension.

Body Params

The image file binary data. Max file size is 20MB.

file
required

The image file to upload. Supported formats: JPG, JPEG, GIF, PNG, ICNS, ICO.

Responses

401

Unauthorized - Authentication credentials missing or invalid

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json