Update Household Leslie Configuration

PUT

https://api.fortresstech.io/v1/households/:householdId/leslieConfiguration

PUT

/v1/households/:householdId/leslieConfiguration

curl -X PUT https://api.fortresstech.io/v1/households/householdId/leslieConfiguration \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "enabled": true
}'

200Updated

{
  "id": "string",
  "householdId": "string",
  "enabled": true,
  "effectiveEnabled": true,
  "isInQuietPeriod": true,
  "disabledReason": "string",
  "disabledById": "string",
  "disabledAt": "2024-01-15T09:30:00Z",
  "disabledUntil": "2024-01-15T09:30:00Z",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "household": {
    "status": "APPLICANT",
    "isUnderEviction": true,
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "currentUnitId": "string",
    "currentLeaseId": "string",
    "applicationId": "string",
    "organizationId": "string",
    "propertyId": "string",
    "currentCertificationId": "string",
    "prospectId": "string",
    "primaryCustomerId": "string",
    "totalActiveRentAmount": 1.1,
    "totalActiveSubsidyAmount": 1.1,
    "totalActiveFeesAmount": 1.1,
    "unitId": "string"
  }
}

Available by Request

Enable or disable the Leslie integration for a specific household. Set enabled to false to disable Leslie, optionally supplying a disabledReason and a disabledUntil timestamp to define a quiet period. disabledUntil is only meaningful when enabled is false and must be a timestamp in the future. Note that disabledUntil is informational only: nothing automatically re-enables the integration when it elapses, but reads after that time will report effectiveEnabled: true even though enabled remains false until someone explicitly re-enables it.

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

householdIdstringRequiredformat: "uuid"

The id of the household

Request

This endpoint expects an object.

enabledbooleanRequired

Whether the Leslie integration should be enabled for this household.

disabledReasonstringOptional<=1000 characters

Optional reason for disabling the integration. Only meaningful when enabled is false.

disabledUntildatetimeOptional

Optional end of the quiet period. Only valid when enabled is false, and must be a future timestamp.

Response

Expected response to a valid request

idstring or nullOptionalformat: "uuid"

householdIdstringOptionalformat: "uuid"

enabledbooleanOptional

Whether the Leslie integration is enabled for this household.

effectiveEnabledbooleanOptional

The value integrations should act on. This accounts for any quiet period that has since ended, and may differ from the raw enabled value.

isInQuietPeriodbooleanOptional

Whether a disabled quiet period is currently active for this household.

disabledReasonstring or nullOptional<=1000 characters

disabledByIdstring or nullOptionalformat: "uuid"

disabledAtdatetime or nullOptional

disabledUntildatetime or nullOptional

createdAtdatetime or nullOptional

updatedAtdatetime or nullOptional

householdobjectOptional