Skip to navigation
Gift ProcessingMail Items

The Mail Item Object

Full schema for the Mail Item resource.
idstringRequiredRead-only
The unique identifier for the mail item.
statusenumRequired

The processing status of a Mail Item.

  • processing: The mail item is being scanned and parsed.
  • needs_review: The mail item requires your review.
  • under_review: Chariot is reviewing the mail item. No action is required.
  • processed: The mail item has been successfully parsed and classified, and is ready for any downstream automations or workflows to run on it.
  • rejected: The mail item will not produce a Donation (e.g., return-to-sender, illegible, unrelated correspondence).
Allowed values:
received_atdatetimeRequired
The date and time when the mail item was physically received at the lockbox.
scanslist of objectsRequired

The scans taken of the mail item, newest first. A mail item typically has one scan; a second scan appears after an admin requests a rescan of the physical mail.

donation_idslist of stringsRequired

The identifiers of the Donations produced from this mail item.

deposit_idslist of stringsRequired

The identifiers of the Deposits produced from this mail item.

created_atdatetimeRequiredRead-only
The date and time when the mail item record was created.
updated_atdatetimeRequiredRead-only
The date and time when the mail item record was last updated.
lockbox_idstringOptional
The unique identifier for the lockbox that received the mail item.