/v1/rate-schedules/{rate_schedule_id}/rescheduleAuthentication
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/rate-schedules/<RATE_SCHEDULE_ID>/reschedule' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"effective_date": "2026-10-29"
}'Parameters
rate_schedule_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
effective_datestring | nullDefaults to the first date the notice already delivered (or a new notice) supports.
Format: date
Show effective_date schema
string | nullDefaults to the first date the notice already delivered (or a new notice) supports.
Variant 1: string
stringVariant 2: null
nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"created_at": "2026-10-29T12:00:00Z",
"effective_date": "2026-10-29",
"id": "00000000-0000-4000-8000-000000000001",
"lease_id": "00000000-0000-4000-8000-000000000001",
"new_rate": "<VALUE_MATCHING_PATTERN>",
"notice_required_days": 0,
"previous_rate": "<VALUE_MATCHING_PATTERN>",
"status": "string",
"applied_at": "2026-10-29T12:00:00Z",
"batch_id": "00000000-0000-4000-8000-000000000001",
"held_reason": "string",
"kind": "increase"
},
"meta": {
"request_id": "string"
}
}application/json
dataRateScheduleResponserequiredShow data schema
applied_atstring | nullWhen the change was actually applied to the lease.
Format: date-time
Show applied_at schema
string | nullWhen the change was actually applied to the lease.
Variant 1: string
stringVariant 2: null
nullbatch_idstring | nullThe rent raise this change belongs to, when it came from one.
Format: uuid
Show batch_id schema
string | nullThe rent raise this change belongs to, when it came from one.
Variant 1: string
stringVariant 2: null
nullcreated_atstringrequiredWhen the rate change was scheduled.
Format: date-time
effective_datestringrequiredBusiness date the new rent takes effect. Billing on or after this date uses new_rate.
Format: date
held_reasonstring | nullnotice_late or notice_undelivered when billing held the change at its effective date.
Show held_reason schema
string | nullnotice_late or notice_undelivered when billing held the change at its effective date.
Variant 1: string
stringVariant 2: null
nullidstringrequiredUnique identifier for this rate change.
Format: uuid
kindstringincrease (needed an advance notice and passed the raise guardrails) or adjustment (a decrease or a backdated correction).
Default: "increase"
lease_idstringrequiredThe lease whose rent is changing.
Format: uuid
new_ratestringrequiredRent after the change.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
notice_attemptsintegerFailed attempts to send the notice; the third makes it undeliverable.
Default: 0
notice_channelstring | nullemail, sms or manual.
Show notice_channel schema
string | nullemail, sms or manual.
Variant 1: string
stringVariant 2: null
nullnotice_notestring | nullHow staff delivered the notice outside Facily, when recorded.
Show notice_note schema
string | nullHow staff delivered the notice outside Facily, when recorded.
Variant 1: string
stringVariant 2: null
nullnotice_required_daysintegerrequiredHow many days of advance notice the tenant must be given before the change may take effect.
notice_sent_atstring | nullWhen notice of the change was sent to the tenant. Null when notice is still outstanding.
Format: date-time
Show notice_sent_at schema
string | nullWhen notice of the change was sent to the tenant. Null when notice is still outstanding.
Variant 1: string
stringVariant 2: null
nullnotice_statusstringpending, sending, sent, undeliverable, manual, imported, not_required or legacy. Billing applies an increase only when its notice was given in time.
Default: "pending"
previous_ratestringrequiredRent before the change.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
reasonstring | nullWhy the rent is changing, for example a scheduled increase or a negotiated adjustment.
Show reason schema
string | nullWhy the rent is changing, for example a scheduled increase or a negotiated adjustment.
Variant 1: string
stringVariant 2: null
nullstatusstringrequiredWhere the change stands: scheduled, applied, cancelled, replaced or held.
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