Parameters
JSON body
Request body
application/jsonslugstringRequiredBranch slug (used to identify the branch).
prague-centralnamestringOptionalNew branch display name.
descriptionstring | nullOptionalNew description. Null to clear.
internalCodestring | nullOptionalInternal code (unique per org). Null to clear.
urlstring | nullOptionalPublic URL. Null to clear.
activebooleanOptionalWhether the branch is active.
latitudenumber | nullOptionalGPS latitude.
longitudenumber | nullOptionalGPS longitude.
branchContactIdstring | nullOptionalCuRefNo of the contact representing the branch itself (technical mail / accounting target). Null to unlink.
establishedDatestring | nullOptionalLegal incorporation / business-registry date (ISO timestamp). Null clears.
openedDatestringOptionalDate the branch started serving customers (ISO timestamp). Drives the financial roll-up bucket key. Cannot be null — every branch must have an opened date.
branchType"own" | "franchise" | "partner"OptionalBranch kind. Cannot be null — defaults to "own" if never set.
parentBranchSlugstring | nullOptionalSlug of the operational parent branch. Null detaches. Setting a slug that would create a cycle is rejected.
operatingCompanyContactRefstring | nullOptionalCuRefNo of the contact representing the legal entity operating this branch. Null unlinks (admin then shows a missing-operator warning).