Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsPatch Facility
Search the full API reference Esc to close

Patch Facility

Facilities · REST API reference

Get support
PATCH/v1/facilities/{facility_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/facilities/<FACILITY_ID>' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "string",
  "is_active": false,
  "name": "string",
  "phone": "string",
  "website_url": "string"
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

facility_idpath · stringrequired

Format: uuid

Request body

application/json · Required

emailstring | null

Max length: 255

Show email schema
string | null
Variant 1: string
string
Variant 2: null
null
is_activeboolean | null
Show is_active schema
boolean | null
Variant 1: boolean
boolean
Variant 2: null
null
namestring | null

Min length: 1 · Max length: 255

Show name schema
string | null
Variant 1: string
string
Variant 2: null
null
phonestring | null

Max length: 20

Show phone schema
string | null
Variant 1: string
string
Variant 2: null
null
website_urlstring | null

Max length: 500

Show website_url 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": {
    "code": "string",
    "created_at": "2026-10-29T12:00:00Z",
    "id": "00000000-0000-4000-8000-000000000001",
    "is_active": false,
    "is_live": false,
    "measurement_system": "string",
    "name": "string",
    "timezone": "string",
    "unit_summary": {
      "available": 0,
      "maintenance": 0,
      "occupancy_rate": "<VALUE_MATCHING_PATTERN>",
      "occupied": 0,
      "overlocked": 0,
      "reserved": 0,
      "total": 0,
      "computed_at": "2026-10-29T12:00:00Z",
      "is_stale": false
    },
    "updated_at": "2026-10-29T12:00:00Z",
    "address": {
      "address_type": "string",
      "city": "string",
      "id": "00000000-0000-4000-8000-000000000001",
      "is_primary": false,
      "state": "string",
      "street": "string",
      "zip": "string",
      "country": "US",
      "latitude": "<VALUE_MATCHING_PATTERN>",
      "longitude": "<VALUE_MATCHING_PATTERN>",
      "street_2": "string",
      "verification_status": "string"
    },
    "billing_go_live_on": "2026-10-29"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataFacilityResponserequired

Compact facility representation for list endpoints.

Show data schema
addressAddressResponse | null

Street address of the site.

Show address schema
AddressResponse | null

Street address of the site.

Variant 1: AddressResponse
address_typestringrequired

What the address is used for, for example physical, billing, or mailing.

citystringrequired

City or town.

countrystring

ISO 3166-1 alpha-2 country code.

Default: "US"

idstringrequired

Unique identifier for this address.

Format: uuid

is_primarybooleanrequired

True for the address used by default when only one is needed.

latitudestring | null

Latitude in decimal degrees, where the address has been geocoded.

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

Show latitude schema
string | null

Latitude in decimal degrees, where the address has been geocoded.

Variant 1: string
Variant 2: null
longitudestring | null

Longitude in decimal degrees, where the address has been geocoded.

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

Show longitude schema
string | null

Longitude in decimal degrees, where the address has been geocoded.

Variant 1: string
Variant 2: null
statestringrequired

State, province, or region.

streetstringrequired

First line of the street address.

street_2string | null

Second line, for a unit, suite, or apartment number.

Show street_2 schema
string | null

Second line, for a unit, suite, or apartment number.

Variant 1: string
Variant 2: null
verification_statusstring | null

Outcome of address validation, for example verified, unverified, or corrected.

Show verification_status schema
string | null

Outcome of address validation, for example verified, unverified, or corrected.

Variant 1: string
Variant 2: null
verified_atstring | null

When the address was last validated against a postal database.

Format: date-time

Show verified_at schema
string | null

When the address was last validated against a postal database.

Variant 1: string
Variant 2: null
zipstringrequired

Postal or ZIP code.

Variant 2: null
null
billing_go_live_onstring | null

The go-live date of the facility's billing cutover, or null when none is recorded. Move-ins, move-outs and transfers are refused before it.

Format: date

Show billing_go_live_on schema
string | null

The go-live date of the facility's billing cutover, or null when none is recorded. Move-ins, move-outs and transfers are refused before it.

Variant 1: string
string
Variant 2: null
null
codestringrequired

Short operator-assigned code identifying the facility, unique within the organization.

created_atstringrequired

When the facility record was created.

Format: date-time

emailstring | null

Public contact email address.

Show email schema
string | null

Public contact email address.

Variant 1: string
string
Variant 2: null
null
idstringrequired

Unique identifier for this facility.

Format: uuid

inbound_email_addressstring | null

The facility's own email address on the platform: mail sent to it, and replies to the facility's email, arrive in its Received messages. Read-only. Null when receiving email is off, and on the facility list.

Show inbound_email_address schema
string | null

The facility's own email address on the platform: mail sent to it, and replies to the facility's email, arrive in its Received messages. Read-only. Null when receiving email is off, and on the facility list.

Variant 1: string
string
Variant 2: null
null
is_activebooleanrequired

False for a facility that has been closed or has not yet opened. Inactive facilities are excluded from operational processing.

is_livebooleanrequired

True once billing has been cut over and the facility's local date has reached its go-live date. Move-in, move-out and transfer are locked until then.

measurement_systemstringrequired

Whether unit dimensions are expressed as imperial or metric.

namestringrequired

The facility's public name.

phonestring | null

Public contact telephone number.

Show phone schema
string | null

Public contact telephone number.

Variant 1: string
string
Variant 2: null
null
sms_numberstring | null

The number the facility's texts are sent from and received at, in E.164. Read-only. Null when none is assigned, and on the facility list.

Show sms_number schema
string | null

The number the facility's texts are sent from and received at, in E.164. Read-only. Null when none is assigned, and on the facility list.

Variant 1: string
string
Variant 2: null
null
timezonestringrequired

IANA timezone identifier, for example 'America/New_York'. Billing runs, late fees and business dates all resolve against this rather than UTC.

unit_summaryUnitSummaryResponserequired

Small denormalized aggregate inlined on FacilityResponse.

Show unit_summary schema
availableintegerrequired
computed_atstring | null

Format: date-time

Show computed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
is_staleboolean

Default: false

maintenanceintegerrequired
occupancy_ratestringrequired

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

occupiedintegerrequired
overlockedintegerrequired
reservedintegerrequired
totalintegerrequired
updated_atstringrequired

When the facility record was last modified.

Format: date-time

website_urlstring | null

The facility's public website.

Show website_url schema
string | null

The facility's public website.

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 facilities operations
Build something that works beautifully.

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

Patch Facility | Facily Developers