Admin Settings: Channels

Update a channel

Code/hostname uniqueness excludes the current id. Use the translations map for locale-nested attributes (name, description, seo_*, maintenance_mode_text). Top-level scalar fields broadcast to every configured locale via the repository.

put/settings/channels/{id}

Request

Path parameters

idinteger required
Example:3

Channel ID.

Request body

object required

Response

Channel updated.

idinteger nullable
codestring nullable
namestring nullable
descriptionstring nullable
hostnamestring nullable
themestring nullable
timezonestring nullable
defaultLocaleIdinteger nullable
baseCurrencyIdinteger nullable
rootCategoryIdinteger nullable
isMaintenanceOnboolean nullable
maintenanceModeTextstring nullable
allowedIpsstring[] nullable
logostring nullable
logoUrlstring nullable
faviconstring nullable
faviconUrlstring nullable
localesobject[] nullable
currenciesobject[] nullable
inventorySourcesobject[] nullable
homeSeoobject nullable
translationsobject[] nullable
createdAtstring nullable
updatedAtstring nullable

Changes

No recorded changes to this operation across all 8 revisions of this API.