/bff/routing/update

Updates route properties (slug, canonical status). Only provided fields are updated, others remain unchanged. For canonical switching (unmark old + mark new), prefer the /set-canonical endpoint.

RoutingpostBffRoutingUpdate

Parameters

JSON body

Request body

application/json

idstringRequired

Route ID to update.

Example123

slugstringOptional

New slug value. Must be unique within the organisation.

Examplenew-slug

canonicalbooleanOptional

Set canonical status. Use /set-canonical endpoint for safe canonical switching.

Response schema

1 status code documented

200Success

success"true"Required

Response example

application/json

{
  "success": true
}

Request example

POST /bff/routing/update

post

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

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key