Create or update a route

put

https://developers.bloomreach.io/management/site/v1/channels/{channel_id}/routes/{route_name}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

channel_id

string

required

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

route_name

string

required

Name of route

Body Params

name

string

required

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

layout

string

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

pageTitle

string

default page (header) title

relativeContentPath

string

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

referenceId

string

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

parameters

object

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

documentRequired

boolean

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.

doctypePages

object

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

items

array of objects

a list of child sitemap items.

items

Headers

X-Resource-Version

string

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

Responses

403

Forbidden

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

201Created