Update Household Leslie Configuration

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

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.

<Badge>Available by Request</Badge> 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. <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Path parameters

householdIdstringRequired

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

createdAtdatetimeOptional

disabledAtdatetimeOptional

disabledByIdstringOptionalformat: "uuid"

disabledReasonstringOptional<=1000 characters

disabledUntildatetimeOptional

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.

enabledbooleanOptional

Whether the Leslie integration is enabled for this household.

householdobjectOptional

householdIdstringOptionalformat: "uuid"

idstringOptionalformat: "uuid"

isInQuietPeriodbooleanOptional

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

updatedAtdatetimeOptional

Available by Request

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

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