/v1/facilities/{facility_id}/rent-increase-policyAuthentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest 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 --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
}
}'Parameters
facility_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
resetstring[] | nullShow reset schema
string[] | nullVariant 1: string[]
string[]Variant 2: null
nullsetRentIncreasePolicySet | nullShow set schema
RentIncreasePolicySet | nullVariant 1: RentIncreasePolicySet
amountnumber | string | nullPattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$)
Show amount schema
number | string | nullVariant 1: number
numberVariant 2: string
stringVariant 3: null
nullcap_at_streetboolean | nullShow cap_at_street schema
boolean | nullVariant 1: boolean
booleanVariant 2: null
nullenabledboolean | nullShow enabled schema
boolean | nullVariant 1: boolean
booleanVariant 2: null
nullmodestring | nullValues: "percent", "new_rate"
Show mode schema
string | nullVariant 1: string
stringValues: "percent", "new_rate"
Variant 2: null
nullrun_dayinteger | nullMinimum: 1 · Maximum: 28
Show run_day schema
integer | nullVariant 1: integer
integerVariant 2: null
nullVariant 2: null
nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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
dataRentIncreasePolicyResponserequiredShow data schema
default_effective_datestringrequiredFormat: date
facility_idstringrequiredFormat: uuid
gate_enabledbooleanrequiredWhether the rate_change_advance notification is on; raises are refused while it is off.
guardrailsRentIncreaseGuardrailsrequiredShow guardrails schema
max_step_pctstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
min_months_since_last_increaseintegerrequiredmin_months_since_move_inintegerrequiredmin_effective_datestringrequiredFormat: date
notice_daysintegerrequiredoverriddenstring[]requiredPolicy fields this facility sets itself; the others are inherited.
Show overridden schema
stringpolicyRentIncreasePolicyValuesrequiredShow policy schema
amountstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
cap_at_streetbooleanrequiredenabledbooleanrequiredmodestringrequiredValues: "percent", "new_rate"
run_dayintegerrequiredtodaystringrequiredFormat: date
metaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired