Channel Component Operations8

Channel Layout Operations4

Channel Menu Operations8

Channel Operations13

Channel Route Operations4

Content Document Operations3

Content Export Batch Operations3

Content Import Batch Operations1

Content Page Operations3

Content Resource Bundle Operations3

Content Translation Operations4

Content Type Operations2

Delivery API V1 Operations2

Delivery API V2 Operations2

Folder Operations4

Project Operations7

UI Extensions Config Operations5

Webhook Configuration Operations5

Webhook Execution Operations2

Channel Route Operations

Create or update a route

put/channels/{channel_id}/routes/{route_name}

Request

Base URL
https://developers.bloomreach.io/delivery/site/v2/documents
Auth
none declared
TypeScript
https://skmtc.dev/bloomreach/apis/documents-delivery-api-2-0/docs/channels/:channel_id/routes/:route_name/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

channel_idstring required

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

route_namestring required

Name of route

Headers

X-Resource-Versionstring

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

Request body

namestring required

the name (url path element) of the sitemap item. Each sitemap item name must be unique between its siblings.

layoutstring

the name of the (default) layout definition for rendering a url matching this sitemap item

pageTitlestring

default page (header) title

relativeContentPathstring

the (base) content path, relative to the channel (base) content path to use for rendering this sitemap item page, or any of its children

referenceIdstring

the (unique) reference id value can be used instead of the content path to create a direct link to this sitemap item

parametersobject

a map of string parameters (names/values) for rendering this sitemap item page

documentRequiredboolean

boolean value if the URL should have a (primary) document or folder item. Default false when missing. If the value is true and the URL does not map to a specific content item, the PageModelApi returns a 404 page.

doctypePagesobject

a more specialized page (name) mapping based on the matched document its type

itemsRoute[] circular

Response