CMS Channel

Get, update, or delete a managed content channel.

To get a managed content delivery channel, see CMS Delivery Channel.

Resource

1/connect/cms/channels/channelId

Available version

62.0

HTTP methods

GET, PATCH, DELETE

Request body for PATCH

Managed Content Channel Update

Root XML tag

<ManagedContentChannelUpdateRepresentation>

JSON example

1{
2"name": "New Channel Name"
3}

Properties

Name	Type	Description	Required or Optional	Available Version
`cacheControlMaxAge`	Long	Cache control max age value in seconds.	Optional	62.0
`domain`	String	ID or name of the domain assigned to the public channel.	Optional	62.0
`isDedicatedContentDelivery`	Boolean	Specifies whether the channel has off-core dedicated content delivery enabled (`true`) or not (`false`). Orgs hosted on Hyperforce use off-core dedicated content delivery to deliver content in public channels with high performance and low latency.	Optional	63.0
`isDomainLocked`	Boolean	Specifies whether the domain is locked and can’t be changed (`true`) or not (`false`).	Optional	62.0
`isSearchable`	Boolean	Specifies whether the text contents of the channel are searchable (`true`) or not (`false`).	Optional	62.0
`mediaCacheControlMaxAge`	Long	Media cache control max age value in seconds.	Optional	62.0
`name`	String	Name of the managed content channel.	Required	62.0
`targetId`	String	ID of the target associated with the managed content channel.	Required for all channel types except `PublicUnauthenticated`	62.0

Response body for GET and PATCH

Managed Content Channel

Response for DELETE

204: Successful Delete

Connect REST API Developer Guide