Sign in

v1

latestOpenAPI 3.1.02026-07-24398280.9 KB
Organization management

Update a business entity

This endpoint updates the details of a specified business entity in the system.

put/v1/organization/business_entities/{id}

Path parameters

idstring uuid required

The unique identifier of the business entity to be updated.

Request body

namestring required

The new name of the business entity.

descriptionstring

The new description of the business entity.

Example request

{
  "name": "New business entity name",
  "description": "This is an updated description for the business entity."
}

Response

Business entity successfully updated

idstring uuid required
orgIDstring uuid
parentIDstring uuid nullable
namestring required

The name of the business entity

descriptionstring

A description of the business entity

countryCodestring

The country code of the business entity.

subIndustryCodestring nullable

The sub-industry code of the business entity or functional unit, formatted as eight digits.

facilityTypeIDstring uuid nullable

The facility type of the business entity if it is a facility.

processTypeIDstring uuid nullable

The process type of the business entity if it is a process.

businessEntityTypeIDstring uuid
defaultFunctionalUnitIDstring uuid
defaultDisplayUnitstring

The default display unit for the functional unit of the business entity

activeStartTimestampnumber

The timestamp when the business entity becomes active, in milliseconds since epoch

activeEndTimestampnumber

The timestamp when the business entity becomes inactive, in milliseconds since epoch

Example response

{
  "name": "Manufacturing plant",
  "description": "The building where things are manufactured"
}