/bff/routing/add

Creates a new route (URL slug) pointing to an entity. The slug is automatically sanitized and made unique by appending a numeric suffix if needed. New routes are marked as canonical by default.

RoutingpostBffRoutingAdd

Parameters

4 body

4 total

Body · 4

typestring | string | string | stringRequired

Route entity type code.

localestringRequired

Communication locale code used to filter content.

Supported locales: cs, en, fr, it, pl, de, sk, sv, es, zh, ja, uk, da.

Length: 2–2

slugstringRequired

Desired URL slug. Will be automatically sanitized and deduplicated (e.g. "My Article!" becomes "my-article", or "my-article-2" if already taken).

relatedEntityIdstringRequired

ID of the entity this route points to. Accepts internal numeric ID or external ID (e.g. "SohsLD38Hw8vs4MC"); external IDs are resolved against the entity table for the given type.

Request

POST /bff/routing/add

post

curl -X POST "https://api.bizkithub.com/bff/routing/add" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "locale": "cs",
  "slug": "my-article",
  "relatedEntityId": "42"
}'

Response

JSON payload

{
  "success": true,
  "id": "example_id",
  "slug": "example_slug"
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key