Channel Operations

Update an existing channel

Update an existing channel developer branch

put/channels/{channel_id}

Request

Base URL
https://developers.bloomreach.io/delivery/site/v2/documents
Auth
none declared
TypeScript
https://skmtc.dev/bloomreach/apis/documents-delivery-api-2-0/docs/channels/:channel_id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

channel_idstring required

Channel id. Optionally includes the project id, separated by a dash: mychannel-branchId

Headers

X-Resource-Versionstring

Resource's version. Must be used in any subsequent update requests of this resource. Can be obtained when GETting the resource

Request body

idstring

identifier for a specific channel branch; constructed as "<channel name>-<channel branch>"

namestring required

identifying name of a channel

projectNamestring required

channel's project name

branchstring

name of the channel branch

branchOfstring

name of channel branch this branch is branched from (if branched)

externalPreviewEnabledboolean

External preview flag

externalPreviewTokenstring

External preview token

updateComponentContentOnPageSyncboolean

The default value of updateContentOnPageSync property on page specific component instances in pages, which identifies if the content of the component instance as a target page will be overwritten with the content from the soure page in page synchronization.

contentRootPathstring required

the (repository) content path (as child of /content) to be used as base content path for this channel; cannot be (only) /

iconstring

the icon used to identify the channel, stored as a Data URL (data:[<mediatype>][;base64],<data>)

localestring

(content) locale to be used and assumed for this channel

devicesstring[]

names and width of supported delivery tier 'devices' to choose from for the Channel Manager (preview) rendering

defaultDevicestring

name of the default 'device' to use by default for the Channel Manager (preview) rendering, defaults to "default" if not configured

responseHeadersobject

optional response headers to provide on a (PMA) response

linkurlPrefixstring

The prefix to prepend to links when the Channel PMA is accessed through a reverse proxy

cdnHoststring

The CDN to use (where applicable and possible)

remoteHostProtectionboolean

Whether remote host protection is enabled

parametersobject

a map of parameters (names/values) for this Channel

Response