Keep a file in the organization's intake inbox until a case is started: a PDF, JPEG or PNG of at most 4 MB, decided by its contents. The inbox holds 50 waiting files (409 `inbox_full`), each for 30 days. Live only: a test key answers 422 `live_only`

post/v1/intake/files

Request

  • Base URL: https://api.evictionsapi.com
  • URL: https://api.evictionsapi.com/v1/intake/files
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

filenamestring required
purpose'lease' | 'ledger' | 'correspondence' | 'other'
notestring
contentBase64string required

Response

The stored file, without its name or note: the list gives them back while the file waits.

idstring required
source'email' | 'agent' required
contentType'application/pdf' | 'image/jpeg' | 'image/png' required
purposeGuess'lease' | 'ledger' | 'correspondence' | 'other' required
receivedAtstring date-time required
expiresAtstring date-time required

Changes

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