Insert a section

externalIdentifier

string

No

External identifier of the section, as set by the integrating system. Maximum length 100 characters.

name

string

No

Name of the section. Maximum length 256 characters.

categoryName

string

Yes

Category assigned to the section. Category values are configurable in the Bloxs admin module. Maximum length 256 characters.

extraRelations

array of object

No

Additional relations to link to the section. Only existing relations can be linked.

extraRelations.extraRelationTypeName

string

No

Relation type to assign to the linked party for this object, for example cleaner or maintenance. Configurable in the Bloxs admin module.

extraRelations.relationReference

string

No

Reference of the relation to link. Must correspond to an existing relation already registered in Bloxs.

remarks

string

No

Free text remarks to store on the section.

underManagementSince

string (date)

No

Date the section comes under management. ISO 8601 format, for example 2026-01-01.

complexReference

string

Yes

Reference of the complex the section belongs to. Must be an existing complex. Maximum length 100 characters.

address.street

string

Yes

Street name of the section's address. Maximum length 200 characters.

address.houseNumber

string

No

House number of the section's address, including any suffix. Can also be used to enter a room number. Maximum length 40 characters.

address.postalCode

string

Yes

Postal code of the section's address. Maximum length 20 characters.

address.city

string

Yes

City of the section's address. Maximum length 200 characters.

address.countryISOCode

string

Yes

ISO 3166-1 alpha-2 country code of the section's address, for example "NL". Maximum length 2 characters.

reference

string

No

Internal identifier generated by Bloxs for the newly created section. This value must be stored by the integrating system and used to identify the section in all subsequent operations.

externalIdentifier

string

No

External identifier of the section, as set by the integrating system.

name

string

No

Name of the section.

displayName

string

No

Display name of the section, as shown in Bloxs.

ownerReference

string

No

Reference of the owner the section belongs to. Inherited from the complex the section is part of; not set directly through this endpoint.

categoryName

string

No

Category assigned to the section.

extraRelations

array of object

No

Additional relations linked to the section. Empty or omitted when no extra relations are set.

extraRelations.extraRelationTypeName

string

No

Relation type assigned to the linked party for this object.

extraRelations.relationReference

string

No

Reference of the linked relation.

remarks

string

No

Free text remarks stored on the section.

underManagementSince

string (date-time)

No

Date the section came under management. ISO 8601 format, for example 2026-01-01T00:00:00.

salesDate

string (date-time)

No

Date the section was sold, if applicable. ISO 8601 format.

lastModified

string (date-time)

Yes

Date and time the section was last modified. ISO 8601 format, UTC.

address.street

string

Yes

Street name of the section's address. Maximum length 200 characters.

address.houseNumber

string

No

House number of the section's address, including any suffix. Maximum length 40 characters.

address.postalCode

string

Yes

Postal code of the section's address. Maximum length 20 characters.

address.city

string

Yes

City of the section's address. Maximum length 200 characters.

address.countryISOCode

string

Yes

ISO 3166-1 alpha-2 country code of the section's address. Maximum length 2 characters.

complexReference

string

No

Reference of the complex the section belongs to.

totalRawFloorArea

number (double)

No

Total raw floor area of all units associated with the section, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period.

totalRentableFloorArea

number (double)

No

Total rentable floor area of all units associated with the section, in square meters, measured according to the NEN2580 standard. Decimals are separated with a period.

totalUsableFloorArea

number (double)

No

Total usable floor area of all units associated with the section, in square meters.