> ## Documentation Index > Fetch the complete documentation index at: https://docs.kodelabs.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a space assignment > Assigns a tenant to one or more leasable spaces for a period. > [!WARNING] > > With `exclusive` set to `true`, KODE deletes every other assignment of the tenant in this building before it creates the new one. This cannot be undone. Leave `exclusive` out unless you mean to replace the tenant's assignments. > [!NOTE] > > Each space must be a space unit that is leasable. A level, a zone, or a space unit that is not leasable fails with `400` and the message "Invalid Spaces for Assignment". A tenant or space that is not in this building fails with `400`, and nothing is created. > [!NOTE] > > The response is `200`, not `201`. `isActive` is `true` when the assignment has started and has not ended. An assignment with no `startDate` is not active. The `type` is always `lease`. ## OpenAPI ````yaml /openapi/kode-api.yaml post /api/v1/buildings/{buildingId}/space-assignments openapi: 3.1.0 info: title: KODE API version: 1.0.0 summary: Programmatic access to KODE OS resources and operations. description: > Use the KODE API to work with buildings, data sources, connectors, devices, points, virtual devices, timeseries data, schedules, the ontology, templating, mass writes, spaces, space assignments, tenants, meters, users, actions, and AssetOps work orders. license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.kodelabs.com/kodeos description: KODE API security: - bearerAuth: [] tags: - name: Authentication description: OAuth 2.0 discovery, token, and revocation endpoints. - name: Buildings description: Buildings and their areas. - name: Data sources description: Data sources connected to a building. - name: Devices description: Devices and their points. - name: Points description: Point queries and point writes. - name: Timeseries description: Current and historical point values. - name: Actions description: Actions exposed by building data sources. - name: Work orders description: AssetOps work orders, lookups, comments, and attachments. - name: Connectors description: KODE API connectors and the devices and points ingested through them. - name: Schedules description: Schedules discovered on building data sources. - name: Templating description: Apply ontology templates to groups of points. - name: Virtual devices description: Virtual devices that group points from other devices. - name: Ontology description: Canonical types, fields, units, and connections of the KODE ontology. - name: Users description: Users of the organization and their app access. - name: Mass write description: Write values to many points across buildings, and follow each run. - name: Spaces description: Levels and space units of a building, and the meters located in them. - name: Space assignments description: Assign tenants to leasable spaces of a building for a period. - name: Tenants description: Tenants of a building, the people or companies that lease its spaces. - name: Meters description: >- Meters of a building, their space assignments, parent and child links, and readings. paths: /api/v1/buildings/{buildingId}/space-assignments: post: tags: - Space assignments summary: Create a space assignment description: Assigns a tenant to one or more leasable spaces for a period. operationId: createSpaceAssignment parameters: - $ref: '#/components/parameters/BuildingId' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSpaceAssignmentRequest' required: true responses: '200': description: The created assignment. content: application/json: schema: $ref: '#/components/schemas/SpaceAssignmentPublic' '400': description: >- `tenantId` or `spaceIds` is missing or blank, a date or another field has the wrong type, the tenant is not found ("Actors not found"), a space is not found ("Spaces not found"), or a space cannot be assigned ("Invalid Spaces for Assignment"). '401': $ref: '#/components/responses/Unauthorized' '403': description: >- The building does not exist or is not assigned to the service account. KODE API answers `403` in both cases so that building ids cannot be probed. '429': $ref: '#/components/responses/TooManyRequests' components: parameters: BuildingId: name: buildingId in: path required: true description: Building identifier from List buildings. schema: type: string example: 67c960faffaa42223163099e schemas: CreateSpaceAssignmentRequest: type: object required: - tenantId - spaceIds properties: tenantId: description: >- Identifier of the tenant. The tenant must be in this building. Required. type: string pattern: \S spaceIds: description: >- Identifiers of the spaces to assign. Each must be a leasable space unit in this building. Required. type: array items: type: string minItems: 1 startDate: $ref: '#/components/schemas/LocalDate' description: First day of the assignment (`YYYY-MM-DD`). endDate: $ref: '#/components/schemas/LocalDate' description: Last day of the assignment (`YYYY-MM-DD`). description: description: Free text about the assignment. type: string exclusive: description: >- Set to `true` to delete the tenant's other assignments in this building before this one is created. The default is `false`. type: boolean SpaceAssignmentPublic: type: object properties: _id: description: Assignment identifier. type: string organizationId: type: string createdAt: $ref: '#/components/schemas/Date' type: string readOnly: true updatedAt: $ref: '#/components/schemas/Date' type: string readOnly: true tenant: $ref: '#/components/schemas/TenantRef' description: The tenant of the assignment. spaces: description: The spaces of the assignment. type: array items: $ref: '#/components/schemas/SpaceRefPublic1' startDate: $ref: '#/components/schemas/LocalDate' description: First day of the assignment. endDate: $ref: '#/components/schemas/LocalDate' description: Last day of the assignment. type: description: Always `lease`. type: string description: description: Free text about the assignment. type: string isActive: description: >- `true` when the assignment has started and has not ended. An assignment with no start date is not active. type: boolean LocalDate: type: string format: date examples: - '2022-03-10T00:00:00.000Z' Date: type: string description: >- Date and time in UTC, with a numeric offset and no colon, for example `2026-10-28T13:51:31+0000`. examples: - 2026-10-28T13:51:31+0000 TenantRef: type: object properties: _id: type: string name: type: string type: type: string SpaceRefPublic1: type: object properties: _id: type: string name: type: string category: type: string responses: Unauthorized: description: The access token is missing, invalid, or expired. Request a new token. TooManyRequests: description: >- A rate-limit window is exhausted. Wait, then retry with increasing delays. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Paste an access token from [Create an access token](/products/kode-api/api-reference/authentication/create-an-access-token). Tokens expire, so request a new one if you receive `401`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.