Docs
Management API
Settings
Favicon Image

Favicon Image

Create Favicon Image

POST /settings/favicon/image

Request

Uploads an image file to use as the storefront favicon. Supported MIME types include GIF, JPEG, and PNG.

  • Channel ID can be used as a query parameter for updating channel-specific settings. If omitted, you will interact with the global settings only.
  • The uploaded image can be up to 10 MB. Larger files result in an error.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.
  • channel_id in query - integer
    Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.

Body

object | multipart/form-data

  • FaviconFile    string

Response

OK
Did you find what you were looking for?
Update Transactional Email SettingsCreate Favicon Image