/v1/facilities/{facility_id}/delinquency/activationAuthentication
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 DELETE \
--url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/delinquency/activation' \
--header "Authorization: Bearer $FACILY_API_KEY"Parameters
facility_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"active_grant_count": 0,
"applied": false,
"candidates": [
{
"backfilled": [
"string"
],
"balance": "<VALUE_MATCHING_PATTERN>",
"days_past_due": 0,
"lease_id": "00000000-0000-4000-8000-000000000001",
"tenant_id": "00000000-0000-4000-8000-000000000001",
"unit_id": "00000000-0000-4000-8000-000000000001",
"fires": "string",
"lien_backfill": "string"
}
],
"exempt_tenant_ids": [
"00000000-0000-4000-8000-000000000001"
],
"facility_id": "00000000-0000-4000-8000-000000000001",
"facility_name": "string",
"gates": [
{
"channels": [
"string"
],
"enabled": false,
"key": "string",
"templates": {}
}
],
"imported_lien_notice_lease_ids": [
"00000000-0000-4000-8000-000000000001"
],
"notices_without_gate": false,
"overlocked_unit_ids": [
"00000000-0000-4000-8000-000000000001"
],
"recurring_stages": [
{}
],
"stages": [
{}
],
"today": "2026-10-29"
},
"meta": {
"request_id": "string"
}
}application/json
dataActivationPlanResponserequiredWhat activating the engine at this facility would do -- or, after a POST, what it did. Read-only until `applied` is true.
Show data schema
access_provider_activebooleanTrue when a lock provider enforces this facility's gate lockouts. False means a lockout is recorded on the tenant's access but locks no gate.
Default: false
activated_atstring | nullWhen the delinquency engine was activated here.
Format: date-time
Show activated_at schema
string | nullWhen the delinquency engine was activated here.
Variant 1: string
stringVariant 2: null
nullactive_grant_countintegerrequiredLive access grants the engine could suspend.
appliedbooleanrequiredFalse for a preview, true when this response records a change.
billing_cutover_atstring | nullWhen billing went live here; activation requires it.
Format: date-time
Show billing_cutover_at schema
string | nullWhen billing went live here; activation requires it.
Variant 1: string
stringVariant 2: null
nullcandidatesActivationCandidateResponse[]requiredThe leases the first sweep would act on.
Show candidates schema
backfilledstring[]requiredStage keys the sweep would record as already passed, without firing.
Show backfilled schema
stringbalancestringrequiredOutstanding balance as of the plan's date.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
days_past_dueintegerrequiredDays past due as of the plan's date.
firesstring | null`{kind}:{index}` of the stage the first sweep would fire.
Show fires schema
string | null`{kind}:{index}` of the stage the first sweep would fire.
Variant 1: string
stringVariant 2: null
nulllease_idstringrequiredThe lease.
Format: uuid
lien_backfillstring | nullThe lien stage key the sweep would backfill, if any.
Show lien_backfill schema
string | nullThe lien stage key the sweep would backfill, if any.
Variant 1: string
stringVariant 2: null
nulltenant_idstringrequiredThe tenant.
Format: uuid
unit_idstringrequiredThe unit.
Format: uuid
exempt_tenant_idsstring[]requiredTenants held out of the engine.
Show exempt_tenant_ids schema
stringfacility_idstringrequiredThe facility.
Format: uuid
facility_namestringrequiredIts name.
gatesActivationGateResponse[]requiredThe notification gates and their template coverage.
Show gates schema
channelsstring[]requiredThe channels the gate sends on.
Show channels schema
stringenabledbooleanrequiredTrue when the facility has the gate switched on.
keystringrequiredThe trigger gate: delinquency, lien or payment_reminder.
templatesobjectrequiredPer gated channel: does a template resolve for this key?
imported_lien_notice_lease_idsstring[]requiredLeases whose imported history already shows a lien notice.
Show imported_lien_notice_lease_ids schema
stringleases_without_access_grantintegerActive leases with no access grant. Activation is refused while this is above zero.
Default: 0
lien_min_days_to_saleinteger | nullStatutory minimum days between the sale notice and the sale under that state's entry (the later of the notice's own floor and the advertising cadence's); null when no entry resolves.
Show lien_min_days_to_sale schema
integer | nullStatutory minimum days between the sale notice and the sale under that state's entry (the later of the notice's own floor and the advertising cadence's); null when no entry resolves.
Variant 1: integer
integerVariant 2: null
nulllien_statestring | nullThe state whose lien statute governs this facility.
Show lien_state schema
string | nullThe state whose lien statute governs this facility.
Variant 1: string
stringVariant 2: null
nullnotices_without_gatebooleanrequiredTrue when the pipeline sends notices while the delinquency gate is off.
overlocked_unit_idsstring[]requiredUnits already overlocked before activation.
Show overlocked_unit_ids schema
stringrecurring_stagesobject[]requiredThe late fees and reminders it switches on with it.
Show recurring_stages schema
objectstagesobject[]requiredThe escalation pipeline activation switches on.
Show stages schema
objectstatute_reviewedboolean | nullWhether that statute entry has been reviewed.
Show statute_reviewed schema
boolean | nullWhether that statute entry has been reviewed.
Variant 1: boolean
booleanVariant 2: null
nulltodaystringrequiredThe facility-local date the plan was computed for.
Format: 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