Update an existing channel

put

https://developers.bloomreach.io/management/site/v1/channels/{channel_id}

Update an existing channel developer branch

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

channel_id

string

required

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

Body Params

string

identifier for a specific channel branch; constructed as "

name

string

required

identifying name of a channel

branch

string

name of the channel branch

branchOf

string

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

externalPreviewEnabled

boolean

External preview flag

externalPreviewToken

string

External preview token

updateComponentContentOnPageSync

boolean

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.

contentRootPath

string

required

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

icon

string

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

locale

string

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

devices

array of strings

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

devices

defaultDevice

string

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

responseHeaders

object

optional response headers to provide on a (PMA) response

linkurlPrefix

string

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

cdnHost

string

The CDN to use (where applicable and possible)

remoteHostProtection

boolean

Whether remote host protection is enabled

parameters

object

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

Headers

X-Resource-Version

string

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

Responses

403

Forbidden

201OK