/api/v1/customer/set-parent

Assigns a parent (superior) customer for the given cuRefNo. Pass null/omit parentCuRefNo to detach. Rejected when the target would create a cycle or when customer equals parent.

customerpostApiV1CustomerSet-parent

Parameters

1 query · JSON body

Query parameters

· 1

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

Request body

application/json

cuRefNostringRequired

cuRefNo = customer reference number.

Length: 16–16

Example1cGIHvFoQDGLAbcA

parentCuRefNostring | nullOptional

One of 2:

Variant 1

string

External ID of the new superior. Pass null or omit to detach (customer becomes a root node).

Length: 16–16

Example1cGIHvFoQDGLAbcA

Variant 2

null

Response schema

1 status code documented

200Success

success"true"Required

Response example

application/json

{
  "success": true
}

Request example

POST /api/v1/customer/set-parent

post

curl -X POST "https://api.bizkithub.com/api/v1/customer/set-parent?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "cuRefNo": "1cGIHvFoQDGLAbcA"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key