BizKitHub
DocsAPI ReferenceRouting/bff/routing/set-canonical
postRoutingAdmin BFF

/bff/routing/set-canonical

Marks a route as the canonical URL for its entity and locale. All other routes for the same entity, type, and locale are automatically unmarked. Canonical routes are used for link generation and SEO (rel=canonical).

RoutingpostBffRoutingSet-canonical

Parameters

JSON body

Request body

application/json
idstringRequired

Route ID to mark as canonical.

Example123

Response schema

1 status code documented

200Success
success"true"Required

Response example

application/json
{
  "success": true
}

Request example

POST /bff/routing/set-canonical

post
curl -X POST "https://api.bizkithub.com/bff/routing/set-canonical" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "123"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key