DocsAPI ReferenceBranch/bff/branch/change-slug
postBranchAdmin BFF

/bff/branch/change-slug

Renames the slug of a branch. The new slug is sanitized and deduplicated so that it remains unique within the organisation.

BranchpostBffBranchChange-slug

Parameters

2 body

2 total
Body · 2
currentSlugstringRequired

Current branch slug.

newSlugstringRequired

Desired new slug (will be slugified/deduplicated).

Length: 1

Request

POST /bff/branch/change-slug

post
curl -X POST "https://api.bizkithub.com/bff/branch/change-slug" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "currentSlug": "example_currentSlug",
  "newSlug": "example_newSlug"
}'

Response

JSON payload

{
  "success": false,
  "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