---
title: "Create a unit"
method: POST
path: "/inventory/v0-nsfw/units"
tags: ["Unit"]
---

# Create a unit

`POST /inventory/v0-nsfw/units`

## Request

- Base URL: `https://api.apaleo.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.apaleo.com/inventory/v0-nsfw/units`
- Auth: OAuth 2
  - Implicit: `https://identity.apaleo.com/connect/authorize`
  - Scopes: `units.create`, `setup.manage`, `admin`

Use this call to create a new unit.<br>You must have at least one of these scopes: 'units.create, setup.manage'.

## Headers

- `Idempotency-Key` string

## Request body

- CreateUnitModel
  - `propertyId` string, required: The id of the property where the unit will be created
  - `name` string, required: The name for the unit
  - `description` object, required: The description for the unit
  - `unitGroupId` string, nullable: The id of the unit group
  - `maxPersons` integer, required: Maximum number of persons for the unit
  - `condition` 'Clean' | 'CleanToBeInspected' | 'Dirty', nullable: Condition of the unit
  - `attributes` CreateUnitAttributeModel[], nullable: Collection of user defined attributes of unit
    - `id` string, required: Id of unit attribute
  - `connectedUnits` CreateConnectedUnitModel[], nullable: The list of units this unit is composed of
    - `unitId` string, required: The connected unit id

## Response `201`

Creation of the new unit was successful.

- UnitCreatedModel
  - `id` string, required: The unit id

## Other responses

- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The Request-URI could not be found.
- `415`: Unsupported media type.
- `422`: Validation errors in the request body or query params.
- `499`: Client closed request.
- `500`: An unexpected error occurred.
- `503`: The server is currently unavailable. Please try later.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-inventory-api-not-safe-for-work.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-inventory-api-not-safe-for-work/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-inventory-api-not-safe-for-work/revisions/64434c68f85d?raw)