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

Patch Rent Increase Policy

Pricing & rates · REST API reference

Get support
PATCH/v1/facilities/{facility_id}/rent-increase-policy

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>/rent-increase-policy' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "reset": [
    "enabled"
  ],
  "set": {
    "amount": 0,
    "cap_at_street": false,
    "enabled": false,
    "mode": "percent",
    "run_day": 1
  }
}'
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

resetstring[] | null
Show reset schema
string[] | null
Variant 1: string[]
string[]
Variant 2: null
null
setRentIncreasePolicySet | null
Show set schema
RentIncreasePolicySet | null
Variant 1: RentIncreasePolicySet
amountnumber | string | null

Pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$)

Show amount schema
number | string | null
Variant 1: number
number
Variant 2: string
string
Variant 3: null
null
cap_at_streetboolean | null
Show cap_at_street schema
boolean | null
Variant 1: boolean
boolean
Variant 2: null
null
enabledboolean | null
Show enabled schema
boolean | null
Variant 1: boolean
boolean
Variant 2: null
null
modestring | null

Values: "percent", "new_rate"

Show mode schema
string | null
Variant 1: string
string

Values: "percent", "new_rate"

Variant 2: null
null
run_dayinteger | null

Minimum: 1 · Maximum: 28

Show run_day schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
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": {
    "default_effective_date": "2026-10-29",
    "facility_id": "00000000-0000-4000-8000-000000000001",
    "gate_enabled": false,
    "guardrails": {
      "max_step_pct": "<VALUE_MATCHING_PATTERN>",
      "min_months_since_last_increase": 0,
      "min_months_since_move_in": 0
    },
    "min_effective_date": "2026-10-29",
    "notice_days": 0,
    "overridden": [
      "string"
    ],
    "policy": {
      "amount": "<VALUE_MATCHING_PATTERN>",
      "cap_at_street": false,
      "enabled": false,
      "mode": "percent",
      "run_day": 0
    },
    "today": "2026-10-29"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataRentIncreasePolicyResponserequired
Show data schema
default_effective_datestringrequired

Format: date

facility_idstringrequired

Format: uuid

gate_enabledbooleanrequired

Whether the rate_change_advance notification is on; raises are refused while it is off.

guardrailsRentIncreaseGuardrailsrequired
Show guardrails schema
max_step_pctstringrequired

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

min_months_since_last_increaseintegerrequired
min_months_since_move_inintegerrequired
min_effective_datestringrequired

Format: date

notice_daysintegerrequired
overriddenstring[]required

Policy fields this facility sets itself; the others are inherited.

Show overridden schema
string
policyRentIncreasePolicyValuesrequired
Show policy schema
amountstringrequired

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

cap_at_streetbooleanrequired
enabledbooleanrequired
modestringrequired

Values: "percent", "new_rate"

run_dayintegerrequired
todaystringrequired

Format: date

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

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

Patch Rent Increase Policy | Facily Developers