Channels | Documentation | Contentful Docs

A channel is an organization-scoped definition of a digital delivery medium through which content and experiences are delivered. Examples of channels include the web, mobile apps, email, and push notifications.

The Channel body has the following schema:

Field	Type	Required	Description
name	String	true	Human-readable name of the Channel
description	String	true	What the Channel is for
properties	Array	true	Properties every linked Destination must supply
nodeProperties	Array	true	Properties carried by the Destination Nodes of every linked Destination
sys	Object	true	System resource properties

Properties

Each entry in properties declares a value that Destinations supply:

Field	Type	Description
name	String	Human-readable name of the property
id	String	Identifier a Destination uses to supply this value. Must be unique within the Channel
type	String	Value type accepted for this property. One of `String`, `Boolean`, or `Number`

Destination Node properties

Each entry in nodeProperties declares a value that Destination Nodes carry:

Field	Type	Description
name	String	Human-readable name of the Destination Node property. Must be unique within the Channel
type	String	Value type accepted for this Destination Node property. `Path` marks the Destination Node property that supplies routing paths

A Channel can declare at most one Destination Node property of type Path.

Channels collection

List all Channels

Create a new Channel

Channel

Get a Channel by ID

Upsert a Channel by ID

Delete a Channel by ID

Publishing

Publish a Channel

Unpublish a Channel