Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsUpdate Unit Type
Search the full API reference Esc to close

Update Unit Type

Unit types · REST API reference

Get support
PATCH/v1/unit-types/{unit_type_id}

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request PATCH \
  --url 'https://api.staging.facily.ai/v1/unit-types/<UNIT_TYPE_ID>' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "string",
  "feature_ids": [
    "00000000-0000-4000-8000-000000000001"
  ],
  "name": "string"
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

unit_type_idpath · stringrequired

Format: uuid

Request body

application/json · Required

descriptionstring | null
Show description schema
string | null
Variant 1: string
string
Variant 2: null
null
feature_idsstring[] | null
Show feature_ids schema
string[] | null
Variant 1: string[]
string[]
Variant 2: null
null
namestring | null
Show name schema
string | null
Variant 1: string
string
Variant 2: null
null

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": {
    "created_at": "2026-10-29T12:00:00Z",
    "facility_id": "00000000-0000-4000-8000-000000000001",
    "features": [
      {
        "created_at": "2026-10-29T12:00:00Z",
        "facility_id": "00000000-0000-4000-8000-000000000001",
        "id": "00000000-0000-4000-8000-000000000001",
        "name": "string",
        "description": "string",
        "short_code": "string"
      }
    ],
    "id": "00000000-0000-4000-8000-000000000001",
    "name": "string",
    "unit_count": 0,
    "updated_at": "2026-10-29T12:00:00Z",
    "description": "string"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataUnitTypeResponserequired

Unit type -- a billing/account-code grouping. Per Phase 9, no dimensions here.

Show data schema
created_atstringrequired

When the unit type was created.

Format: date-time

descriptionstring | null

Longer description of the type, where the operator has written one.

Show description schema
string | null

Longer description of the type, where the operator has written one.

Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

The facility this unit type belongs to.

Format: uuid

featuresFeatureResponse[]required

Characteristics shared by every unit of this type.

Show features schema
created_atstringrequired

Format: date-time

descriptionstring | null
Show description schema
string | null
Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

The facility this feature is defined for.

Format: uuid

idstringrequired

Unique identifier for this feature.

Format: uuid

namestringrequired

Display name of the characteristic, for example 'Climate Controlled' or 'Drive-Up Access'.

short_codestring | null

Short abbreviation used where space is tight, such as a unit grid.

Show short_code schema
string | null

Short abbreviation used where space is tight, such as a unit grid.

Variant 1: string
string
Variant 2: null
null
idstringrequired

Unique identifier for this unit type.

Format: uuid

namestringrequired

Operator-facing name for the type, for example '10x10 Climate Controlled'.

unit_countintegerrequired

How many units are currently classified under this type.

updated_atstringrequired

When the unit type was last modified.

Format: date-time

metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll unit types operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Update Unit Type | Facily Developers