Destination Nodes | Documentation

Destination nodes form the routing tree of a destination. Each destination node belongs to one of three types. The API infers the node type from the fields included in the request body; it does not accept an explicit type field. Determine the required node type before constructing the request:

Destination Node type	Create one to	Make it one by sending	`sys.type` in the response
Folder	Group other Destination Nodes under a path without serving anything at it	Neither `experience` nor `redirectTo`	`DestinationFolderNode`
Experience	Serve a published experience at a path	`experience`	`DestinationExperienceNode`
Redirect	Send a path to a Destination Experience Node served elsewhere in the tree	`redirectTo`	`DestinationRedirectNode`

The request body must contain the distinguishing field for the intended node type. If it contains neither distinguishing field, the API creates a valid DestinationFolderNode. As a result, omitting the required field from an intended DestinationExperienceNode or DestinationRedirectNode doesn’t produce a validation error. Instead, the API creates a folder node that doesn’t resolve to an experience or redirect target.

If the request body contains both distinguishing fields, it doesn’t match any supported destination node type, and the API rejects the request.

Every request to create or update a destination node includes the following common fields, regardless of the node type:

Field	Type	Required	Description
properties	Array	true	Values for the Destination Node properties the Channel declares. A path is supplied as `{ "path": "/products" }`
parent	Link	false	Parent of the Destination Node, linking to a `Destination`, `DestinationFolderNode`, or `DestinationExperienceNode`. Omit it to attach the Destination Node to the Destination root

The discriminating field determines the destination node type:

Field	Type	Required	Description
experience	ResourceLink	On a Destination Experience Node	The experience served at this path, addressed by its Contentful Resource Name
redirectTo	Link	On a Destination Redirect Node	The `DestinationExperienceNode` this Destination Node redirects to

A destination node response is one of three response variants. Each variant contains properties, parent, and sys, together with the discriminating field for its node kind.

Write operations are validated against the entire destination tree, not only the destination node in the request. Contentful rejects any operation that would:

Create a duplicate path.
Assign the home path to more than one destination node.
Set a destination redirect node target to anything other than a destination experience node.
Violate the integrity of the destination tree.

There is no endpoint that lists destination nodes. Use Get the Destination Node tree for a Destination to enumerate them, or keep the IDs returned by create and upsert requests.

Destination Node

Create a new Destination Node

Get a Destination Node by ID

Upsert a Destination Node by ID

Delete a Destination Node by ID

Publishing

Publish a Destination Node

Unpublish a Destination Node