API ReferenceOrganizations

Move sub-organization

View as Markdown

Moves a sub-organization to a different parent. Updates hierarchy paths and depths for the sub-org and all its descendants. Requires admin role in both the current and new parent orgs.

Authentication

AuthorizationBearer

JWT access token from POST /auth/login or POST /oauth/token

OR
x-api-keystring

Organization-scoped API key created via POST /orgs/:orgId/api-keys. Carries permission grants.

Path parameters

orgIdstringRequired
subOrgIdstringRequired

Request

This endpoint expects an object.
newParentIdstringRequired

Response

Response
idstring
namestring
statusstring
created_atstring
updated_atstring
emailstring or nullOptional
org_typestring or nullOptional
descriptionstring or nullOptional
websitestring or nullOptional
jurisdictionstring or nullOptional
logo_urlstring or nullOptional
banner_urlstring or nullOptional
parent_idstring or nullOptional
hierarchy_pathstring or nullOptional
depthdouble or nullOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error