Change the facts of a draft case, or (`paymentMethodId`, in any state) the saved card a full-service case is charged to. 409 `not_agent_filed` for a card on a case that is not full-service; 422 `payment_method_not_found` for a card that is not one of the organization's usable cards in this mode

patch/v1/cases/{id}

Request

  • Base URL: https://api.evictionsapi.com
  • URL: https://api.evictionsapi.com/v1/cases/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

Request body

ground'nonpayment' | 'lease_violation' | 'holdover'
entryPoint'notice' | 'filing'
amountOwedCentsinteger
rentOwedCentsinteger
freeTextstring
sourcesobject
paymentMethodIdstring nullable

Full-service cases only: the id of the organization's saved card (GET /v1/payment-methods) to charge this case's costs to, or null to use the default card. A body with only this field needs the permission to manage payment methods; 422 payment_method_not_found when the card is not one of the organization's usable cards in this mode.

Response

The updated case.

idstring required
mode'test' | 'live' required
statestring required

Position in the case lifecycle, for example notice_review or filing_submitted.

heldFromstring nullable
groundstring required
entryPoint'notice' | 'filing' required
courtCaseNumberstring nullable
courtstring nullable

The court the case goes to, in words, where the rules for its place say which, with the county: for example "Magistrate court of Henry County". null where no rule pack covers the place, and for an erased case.

packVersionsobject nullable
dataobject required
handling'automated' | 'attorney_direct' | 'agent_filed'

Who does the legal work. attorney_direct: a licensed attorney engaged for the case reviews it, serves the notice and files in court, and the platform records each step; it is what a live case is unless the full-service path is open for its property. automated: the built-in test pipeline of a test case. agent_filed, the full-service path, as we describe it to the owner: We act as your authorized agent. No attorney reviews the case. We are not a law firm and do not give legal advice. Full service is available only in test mode for now; a case is created with it only when POST /v1/cases asks for service: "full" and that path is open for the property, and it needs the owner's signed authorization (/v1/cases/{id}/authorization).

erasedboolean

Whether the details of the case were erased, which we do case by case on request. An erased case keeps its id, state, dates, deadline names and charges. In data the names and the address read [erased] (the state and county are kept) and every other fact is gone; courtCaseNumber is null; each document keeps its id and contentHash, its filename reads [erased] and downloading it answers 410 erased; messages read [erased]. Any request that would change the case answers 409 erased.

erasedAtstring date-time nullable

When the details were erased. Null for a case that was not erased.

sourcesobject

Where each answer came from, by field path (property.line1, lease.monthlyRentCents, parties.0, ledger): the kind of source, and for a file read the id of the case document it was read from. An answer with no entry was typed. Empty when no answer came from a source. Never holds a value. Send sources with POST /v1/cases or PATCH /v1/cases/{id} to set it (a patch replaces the whole map); a patch that changes an answer without sending sources removes that answer's entry.

agentunknown
paymentMethodIdstring nullable

The organization's saved card (GET /v1/payment-methods) this case's costs are charged to, or null for the default card. Choose it with PATCH /v1/cases/{id}. A chosen card that is removed or declined is not charged: the default card is used instead.

createdAtstring date-time
updatedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.