/v1/facilities/{facility_id}/rent-raisesAuthentication
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 POST \
--url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/rent-raises' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"scope": "group",
"dry_run": false,
"effective_date": "2026-10-29",
"file_name": "string",
"ignore_rules": [
"move_in"
],
"mode": "percent",
"rows": [
{
"lease_id": "00000000-0000-4000-8000-000000000001",
"new_rate": 0,
"effective_date": "2026-10-29"
}
],
"target_id": "00000000-0000-4000-8000-000000000001",
"value": 0
}'Parameters
facility_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
dry_runbooleanDefault: false
effective_datestring | nullDefaults to the first of the month on or after today plus the notice period plus 7 days.
Format: date
Show effective_date schema
string | nullDefaults to the first of the month on or after today plus the notice period plus 7 days.
Variant 1: string
stringVariant 2: null
nullfile_namestring | nullMax length: 255
Show file_name schema
string | nullVariant 1: string
stringVariant 2: null
nullignore_rulesstring[]Show ignore_rules schema
stringValues: "move_in", "last_increase"
modestring | nullValues: "percent", "new_rate"
Show mode schema
string | nullVariant 1: string
stringValues: "percent", "new_rate"
Variant 2: null
nullrowsRentRaiseRowRequest[] | nullMax items: 5000
Show rows schema
RentRaiseRowRequest[] | nullVariant 1: RentRaiseRowRequest[]
effective_datestring | nullThis row's own effective date; the request's when omitted.
Format: date
Show effective_date schema
string | nullThis row's own effective date; the request's when omitted.
Variant 1: string
stringVariant 2: null
nulllease_idstringFormat: uuid
new_ratenumber | stringPattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$)
Show new_rate schema
number | stringVariant 1: number
numberVariant 2: string
stringVariant 2: null
nullscopestringrequiredValues: "group", "lease", "rows"
target_idstring | nullFormat: uuid
Show target_id schema
string | nullVariant 1: string
stringVariant 2: null
nullvaluenumber | string | nullPattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$)
Show value schema
number | string | nullVariant 1: number
numberVariant 2: string
stringVariant 3: null
nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"added_annual": "<VALUE_MATCHING_PATTERN>",
"added_monthly": "<VALUE_MATCHING_PATTERN>",
"avg_new_rate": "<VALUE_MATCHING_PATTERN>",
"avg_previous_rate": "<VALUE_MATCHING_PATTERN>",
"batch_id": "00000000-0000-4000-8000-000000000001",
"default_effective_date": "2026-10-29",
"dry_run": false,
"effective_date": "2026-10-29",
"min_effective_date": "2026-10-29",
"outcomes": [
{
"current_rate": "<VALUE_MATCHING_PATTERN>",
"effective_date": "2026-10-29",
"lease_id": "00000000-0000-4000-8000-000000000001",
"lease_number": "string",
"new_rate": "<VALUE_MATCHING_PATTERN>",
"outcome": "scheduled",
"rate_schedule_id": "00000000-0000-4000-8000-000000000001",
"reason": "string",
"reason_code": "string",
"replaces_existing": false,
"tenant_name": "string",
"unit_number": "string"
}
],
"refused_count": 0,
"scheduled_count": 0,
"skipped_count": 0,
"target_label": "string"
},
"meta": {
"request_id": "string"
}
}application/json
dataRentRaiseResultResponserequiredShow data schema
added_annualstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
added_monthlystringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
avg_new_ratestring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show avg_new_rate schema
string | nullVariant 1: string
stringVariant 2: null
nullavg_previous_ratestring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show avg_previous_rate schema
string | nullVariant 1: string
stringVariant 2: null
nullbatch_idstring | nullrequiredNull on a dry run.
Format: uuid
Show batch_id schema
string | nullNull on a dry run.
Variant 1: string
stringVariant 2: null
nulldefault_effective_datestringrequiredFormat: date
dry_runbooleanrequiredeffective_datestring | nullrequiredFormat: date
Show effective_date schema
string | nullVariant 1: string
stringVariant 2: null
nullmin_effective_datestringrequiredFormat: date
outcomesRentRaiseOutcomeResponse[]requiredShow outcomes schema
current_ratestring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show current_rate schema
string | nullVariant 1: string
stringVariant 2: null
nulleffective_datestringrequiredFormat: date
lease_idstringrequiredFormat: uuid
lease_numberstring | nullrequiredShow lease_number schema
string | nullVariant 1: string
stringVariant 2: null
nullnew_ratestring | nullrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show new_rate schema
string | nullVariant 1: string
stringVariant 2: null
nulloutcomestringrequiredValues: "scheduled", "skipped", "refused"
rate_schedule_idstring | nullrequiredFormat: uuid
Show rate_schedule_id schema
string | nullVariant 1: string
stringVariant 2: null
nullreasonstring | nullrequiredThe same reason in words.
Show reason schema
string | nullThe same reason in words.
Variant 1: string
stringVariant 2: null
nullreason_codestring | nullrequiredMachine reason for a skip or refusal.
Show reason_code schema
string | nullMachine reason for a skip or refusal.
Variant 1: string
stringVariant 2: null
nullreplaces_existingbooleanrequiredTrue when this raise replaces one already on notice.
tenant_namestring | nullrequiredShow tenant_name schema
string | nullVariant 1: string
stringVariant 2: null
nullunit_numberstring | nullrequiredShow unit_number schema
string | nullVariant 1: string
stringVariant 2: null
nullrefused_countintegerrequiredscheduled_countintegerrequiredskipped_countintegerrequiredtarget_labelstringrequiredmetaMetarequiredEnvelope 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