Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsCreate Rent Raise
Search the full API reference Esc to close

Create Rent Raise

Pricing & rates · REST API reference

Get support
POST/v1/facilities/{facility_id}/rent-raises

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 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
}'
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

dry_runboolean

Default: false

effective_datestring | null

Defaults to the first of the month on or after today plus the notice period plus 7 days.

Format: date

Show effective_date schema
string | null

Defaults to the first of the month on or after today plus the notice period plus 7 days.

Variant 1: string
string
Variant 2: null
null
file_namestring | null

Max length: 255

Show file_name schema
string | null
Variant 1: string
string
Variant 2: null
null
ignore_rulesstring[]
Show ignore_rules schema
string

Values: "move_in", "last_increase"

modestring | null

Values: "percent", "new_rate"

Show mode schema
string | null
Variant 1: string
string

Values: "percent", "new_rate"

Variant 2: null
null
rowsRentRaiseRowRequest[] | null

Max items: 5000

Show rows schema
RentRaiseRowRequest[] | null
Variant 1: RentRaiseRowRequest[]
effective_datestring | null

This row's own effective date; the request's when omitted.

Format: date

Show effective_date schema
string | null

This row's own effective date; the request's when omitted.

Variant 1: string
string
Variant 2: null
null
lease_idstring

Format: uuid

new_ratenumber | string

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

Show new_rate schema
number | string
Variant 1: number
number
Variant 2: string
string
Variant 2: null
null
scopestringrequired

Values: "group", "lease", "rows"

target_idstring | null

Format: uuid

Show target_id schema
string | null
Variant 1: string
string
Variant 2: null
null
valuenumber | string | null

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

Show value 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": {
    "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

dataRentRaiseResultResponserequired
Show data schema
added_annualstringrequired

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

added_monthlystringrequired

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

avg_new_ratestring | nullrequired

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

Show avg_new_rate schema
string | null
Variant 1: string
string
Variant 2: null
null
avg_previous_ratestring | nullrequired

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

Show avg_previous_rate schema
string | null
Variant 1: string
string
Variant 2: null
null
batch_idstring | nullrequired

Null on a dry run.

Format: uuid

Show batch_id schema
string | null

Null on a dry run.

Variant 1: string
string
Variant 2: null
null
default_effective_datestringrequired

Format: date

dry_runbooleanrequired
effective_datestring | nullrequired

Format: date

Show effective_date schema
string | null
Variant 1: string
string
Variant 2: null
null
min_effective_datestringrequired

Format: date

outcomesRentRaiseOutcomeResponse[]required
Show outcomes schema
current_ratestring | nullrequired

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

Show current_rate schema
string | null
Variant 1: string
string
Variant 2: null
null
effective_datestringrequired

Format: date

lease_idstringrequired

Format: uuid

lease_numberstring | nullrequired
Show lease_number schema
string | null
Variant 1: string
string
Variant 2: null
null
new_ratestring | nullrequired

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

Show new_rate schema
string | null
Variant 1: string
string
Variant 2: null
null
outcomestringrequired

Values: "scheduled", "skipped", "refused"

rate_schedule_idstring | nullrequired

Format: uuid

Show rate_schedule_id schema
string | null
Variant 1: string
string
Variant 2: null
null
reasonstring | nullrequired

The same reason in words.

Show reason schema
string | null

The same reason in words.

Variant 1: string
string
Variant 2: null
null
reason_codestring | nullrequired

Machine reason for a skip or refusal.

Show reason_code schema
string | null

Machine reason for a skip or refusal.

Variant 1: string
string
Variant 2: null
null
replaces_existingbooleanrequired

True when this raise replaces one already on notice.

tenant_namestring | nullrequired
Show tenant_name schema
string | null
Variant 1: string
string
Variant 2: null
null
unit_numberstring | nullrequired
Show unit_number schema
string | null
Variant 1: string
string
Variant 2: null
null
refused_countintegerrequired
scheduled_countintegerrequired
skipped_countintegerrequired
target_labelstringrequired
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

Create Rent Raise | Facily Developers