Create a draft case
evictions_create_caseUse this when the person wants to start an eviction case and has given you its facts: the ground, where the case starts, the property, the parties and their own attestations. Creates a draft case in the person’s account. Nothing is submitted. Documents are uploaded through the REST API or the site, not this server. Pass an idempotencyKey and reuse it if you repeat the call, so a retry never makes a second case. Do not use this to change a case that already exists (use evictions_update_case). The result is the case, with state and nextAction (who it is waiting on and for what). Next: evictions_validate_case. Needs the person’s account: sign-in or an API key.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lease | No | The lease, when there is one. | |
| ground | Yes | Why the case is brought: nonpayment of rent, a lease violation, or holdover (the tenant stayed after the lease ended). Cannot be changed later. | |
| ledger | No | Rent charges and payments, for a nonpayment case. | |
| parties | Yes | The plaintiff (the owner or manager) and each defendant (tenant). | |
| freeText | No | Anything else the attorney should know. | |
| property | Yes | The rental property and its owner of record. | |
| violation | No | For a lease violation case. | |
| entryPoint | Yes | Where the case starts: `notice` (a notice to the tenant comes first), or `filing` when a notice was already served (then give `priorNotice`). Cannot be changed later. | |
| priorNotice | No | The notice already served, for a case that starts at filing. | |
| attestations | Yes | The person’s own statements about the case. Ask the person for each one; never fill them in yourself. | |
| idempotencyKey | No | Sent as the Idempotency-Key header (printable ASCII, no spaces): a repeat of the same request with the same key returns the first answer instead of a second case. Always pass one, and reuse it if you repeat the call. | |
| amountOwedCents | No | The total the tenant owes now, in US cents (150000 is $1,500.00). |