Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsDeactivate Delinquency
Search the full API reference Esc to close

Deactivate Delinquency

Billing · REST API reference

Get support
DELETE/v1/facilities/{facility_id}/delinquency/activation

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 DELETE \
  --url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/delinquency/activation' \
  --header "Authorization: Bearer $FACILY_API_KEY"
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

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "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

dataActivationPlanResponserequired

What 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_activeboolean

True 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 | null

When the delinquency engine was activated here.

Format: date-time

Show activated_at schema
string | null

When the delinquency engine was activated here.

Variant 1: string
string
Variant 2: null
null
active_grant_countintegerrequired

Live access grants the engine could suspend.

appliedbooleanrequired

False for a preview, true when this response records a change.

billing_cutover_atstring | null

When billing went live here; activation requires it.

Format: date-time

Show billing_cutover_at schema
string | null

When billing went live here; activation requires it.

Variant 1: string
string
Variant 2: null
null
candidatesActivationCandidateResponse[]required

The leases the first sweep would act on.

Show candidates schema
backfilledstring[]required

Stage keys the sweep would record as already passed, without firing.

Show backfilled schema
string
balancestringrequired

Outstanding balance as of the plan's date.

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

days_past_dueintegerrequired

Days 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
string
Variant 2: null
null
lease_idstringrequired

The lease.

Format: uuid

lien_backfillstring | null

The lien stage key the sweep would backfill, if any.

Show lien_backfill schema
string | null

The lien stage key the sweep would backfill, if any.

Variant 1: string
string
Variant 2: null
null
tenant_idstringrequired

The tenant.

Format: uuid

unit_idstringrequired

The unit.

Format: uuid

exempt_tenant_idsstring[]required

Tenants held out of the engine.

Show exempt_tenant_ids schema
string
facility_idstringrequired

The facility.

Format: uuid

facility_namestringrequired

Its name.

gatesActivationGateResponse[]required

The notification gates and their template coverage.

Show gates schema
channelsstring[]required

The channels the gate sends on.

Show channels schema
string
enabledbooleanrequired

True when the facility has the gate switched on.

keystringrequired

The trigger gate: delinquency, lien or payment_reminder.

templatesobjectrequired

Per gated channel: does a template resolve for this key?

imported_lien_notice_lease_idsstring[]required

Leases whose imported history already shows a lien notice.

Show imported_lien_notice_lease_ids schema
string
leases_without_access_grantinteger

Active leases with no access grant. Activation is refused while this is above zero.

Default: 0

lien_min_days_to_saleinteger | null

Statutory 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 | null

Statutory 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
integer
Variant 2: null
null
lien_statestring | null

The state whose lien statute governs this facility.

Show lien_state schema
string | null

The state whose lien statute governs this facility.

Variant 1: string
string
Variant 2: null
null
notices_without_gatebooleanrequired

True when the pipeline sends notices while the delinquency gate is off.

overlocked_unit_idsstring[]required

Units already overlocked before activation.

Show overlocked_unit_ids schema
string
recurring_stagesobject[]required

The late fees and reminders it switches on with it.

Show recurring_stages schema
object
stagesobject[]required

The escalation pipeline activation switches on.

Show stages schema
object
statute_reviewedboolean | null

Whether that statute entry has been reviewed.

Show statute_reviewed schema
boolean | null

Whether that statute entry has been reviewed.

Variant 1: boolean
boolean
Variant 2: null
null
todaystringrequired

The facility-local date the plan was computed for.

Format: date

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
Continue exploringAll billing operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Deactivate Delinquency | Facily Developers