Destinations | Documentation

A Destination implements a Channel’s contract for one space and environment and owns the tree of Destination Nodes that maps paths to published experiences.

The Destination body has the following schema:

Field	Type	Required	Description
name	String	true	Human-readable name of the Destination
description	String	true	What the Destination is for
channelId	String	true on create	ID of the Channel this Destination implements. Fixed once the Destination is created
properties	Array	true	Values for the properties the Channel declares
sys	Object	true	System resource properties

Each entry in properties supplies one value:

Field	Type	Description
id	String	ID of the Channel property this value supplies
value	String, Boolean, or Number	The value itself, matching the type declared by the Channel

Every property ID must match a property declared by the linked Channel, and its value must use the declared type. A mismatch returns 422 Unprocessable Entity.

Destinations collection

List all Destinations

Create a new Destination

Destination

Get a Destination by ID

Update a Destination by ID

Delete a Destination by ID

Destination Node tree

Get the Destination Node tree for a Destination

Publishing

Publish a Destination

Unpublish a Destination