increase-test
POST/inbound_mail_items/{inbound_mail_item_id}/action

Submit actions for an inbound mail item

Submits actions for checks in a pending inbound mail item, depositing checks into a specified account or ignoring them. Provide an action for each check in the checks array; a deposit action uses account_id to identify the destination account.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
inbound_mail_item_idstringrequired
The identifier of the inbound mail item to action.

Actions to perform on the checks in the inbound mail item. The checks array is required.

checksarray<object>required
The actions to perform on the Inbound Mail Item.

3 status codes
200Returns the updated inbound mail item, including the resulting status and check details.
account_idstringrequired
The identifier for the Account that checks in this mail item are deposited into. For mail items that could not be routed to a Lockbox Recipient, this will be null.
checksarray<InboundMailItemCheck>required
The checks in the mail item.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound Mail Item was created.
file_idstringrequired
The identifier for the File containing the scanned contents of the mail item.
idstringrequired
The Inbound Mail Item identifier.
lockbox_address_idstringrequired
The identifier for the Lockbox Address that received this mail item.
lockbox_recipient_idstringrequired
The identifier for the Lockbox Recipient that received this mail item. For mail items that could not be routed to a Lockbox Recipient, this will be null.
recipient_namestringrequired
The recipient name as written on the mail item.
rejection_reasonstringrequired
If the mail item has been rejected, why it was rejected.
Allowed:no_matching_lockboxno_checklockbox_not_activelockbox_address_not_activelockbox_recipient_not_active
statusstringrequired
If the mail item has been processed.
Allowed:pendingprocessedrejected
typestringrequired
A constant representing the object's type. For this resource it will always be `inbound_mail_item`.
Allowed:inbound_mail_item
4XXReturned when the request encounters a client error.
5XXReturned when the server encounters an error.

Error handling

The inbound_mail_item_id path parameter identifies the inbound mail item to action. The checks array is required, and each item must include action, set to deposit or ignore; provide account_id when depositing a check.