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

Update Unit Group

Unit groups · REST API reference

Get support
PATCH/v1/unit-groups/{unit_group_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-groups/<UNIT_GROUP_ID>' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "add_unit_ids": [
    "00000000-0000-4000-8000-000000000001"
  ],
  "code": "string",
  "description": "string",
  "feature_ids": [
    "00000000-0000-4000-8000-000000000001"
  ],
  "floor": 0,
  "max_rate": 0,
  "min_rate": 0,
  "name": "string",
  "remove_unit_ids": [
    "00000000-0000-4000-8000-000000000001"
  ],
  "standard_rate": 0,
  "unit_rates": [
    {
      "standard_rate": 0,
      "unit_id": "00000000-0000-4000-8000-000000000001"
    }
  ],
  "web_rate": 0
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

unit_group_idpath · stringrequired

Format: uuid

Request body

application/json · Required

add_unit_idsstring[]
Show add_unit_ids schema
string
codestring | null
Show code schema
string | null
Variant 1: string
string
Variant 2: null
null
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
floorinteger | null
Show floor schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
max_ratenumber | string | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show max_rate schema
number | string | null
Variant 1: number
number
Variant 2: string
string
Variant 3: null
null
min_ratenumber | string | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show min_rate schema
number | string | null
Variant 1: number
number
Variant 2: string
string
Variant 3: null
null
namestring | null
Show name schema
string | null
Variant 1: string
string
Variant 2: null
null
remove_unit_idsstring[]
Show remove_unit_ids schema
string
standard_ratenumber | string | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show standard_rate schema
number | string | null
Variant 1: number
number
Variant 2: string
string
Variant 3: null
null
unit_ratesUnitRateItem[]
Show unit_rates schema
standard_ratenumber | string | nullrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show standard_rate schema
number | string | null
Variant 1: number
number
Variant 2: string
string
Variant 3: null
null
unit_idstringrequired

Format: uuid

web_ratenumber | string | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show web_rate schema
number | string | null
Variant 1: number
number
Variant 2: string
string
Variant 3: 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",
    "id": "00000000-0000-4000-8000-000000000001",
    "name": "string",
    "updated_at": "2026-10-29T12:00:00Z",
    "code": "string",
    "description": "string",
    "effective_standard_rate": "<VALUE_MATCHING_PATTERN>",
    "effective_web_rate": "<VALUE_MATCHING_PATTERN>",
    "feature_ids": [
      "00000000-0000-4000-8000-000000000001"
    ],
    "floor": 0,
    "managed": false
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataapi__unit_groups__schemas__UnitGroupResponserequired
Show data schema
codestring | null

Short operator-assigned code for the group.

Show code schema
string | null

Short operator-assigned code for the group.

Variant 1: string
string
Variant 2: null
null
created_atstringrequired

When the group was created.

Format: date-time

descriptionstring | null

Longer description of what the group covers.

Show description schema
string | null

Longer description of what the group covers.

Variant 1: string
string
Variant 2: null
null
effective_standard_ratestring | null

The street rate a unit of this group quotes when it has no rate of its own.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show effective_standard_rate schema
string | null

The street rate a unit of this group quotes when it has no rate of its own.

Variant 1: string
string
Variant 2: null
null
effective_web_ratestring | null

The online rate a unit of this group quotes when it has no rate of its own.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show effective_web_rate schema
string | null

The online rate a unit of this group quotes when it has no rate of its own.

Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

The facility this group belongs to.

Format: uuid

feature_idsstring[]

The group's characteristics.

Show feature_ids schema
string
floorinteger | null

Floor the group's units are on, when it has one.

Show floor schema
integer | null

Floor the group's units are on, when it has one.

Variant 1: integer
integer
Variant 2: null
null
idstringrequired

Unique identifier for this unit group.

Format: uuid

managedboolean

True when pricing rules set the effective street rate.

Default: false

managed_ratestring | null

Street rate set by pricing rules; null when none applies.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show managed_rate schema
string | null

Street rate set by pricing rules; null when none applies.

Variant 1: string
string
Variant 2: null
null
managed_web_discountstring | null

Percentage points pricing rules add to the online discount; null when none applies.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show managed_web_discount schema
string | null

Percentage points pricing rules add to the online discount; null when none applies.

Variant 1: string
string
Variant 2: null
null
max_ratestring | null

Ceiling: no pricing rule moves the street rate above it.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show max_rate schema
string | null

Ceiling: no pricing rule moves the street rate above it.

Variant 1: string
string
Variant 2: null
null
min_ratestring | null

Floor: no pricing rule moves the street rate below it.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show min_rate schema
string | null

Floor: no pricing rule moves the street rate below it.

Variant 1: string
string
Variant 2: null
null
namestringrequired

Display name of the group.

rates_changed_atstring | null

When the group's effective street or online rate last changed.

Format: date-time

Show rates_changed_at schema
string | null

When the group's effective street or online rate last changed.

Variant 1: string
string
Variant 2: null
null
standard_ratestring | null

Base street rate the operator set; units with no rate of their own start from it.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show standard_rate schema
string | null

Base street rate the operator set; units with no rate of their own start from it.

Variant 1: string
string
Variant 2: null
null
updated_atstringrequired

When the group was last modified.

Format: date-time

web_managedboolean

True when a pricing rule adjusts the effective online rate.

Default: false

web_ratestring | null

Base online rate the operator set, optional.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show web_rate schema
string | null

Base online rate the operator set, optional.

Variant 1: string
string
Variant 2: null
null
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 groups operations
Build something that works beautifully.

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

Update Unit Group | Facily Developers