Virtual Mailboxes

Create Test Virtual Mailbox Item

Changed on

Create a test item for a virtual mailbox. This is only available in test mode, an error will be returned if you attempt this call in live mode.

post/print-mail/v1/virtual_mailboxes/{id}/items

Request

  • Base URL
    https://api.postgrid.com
  • URL
    https://api.postgrid.com/print-mail/v1/virtual_mailboxes/{id}/items
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

Request body

descriptionstring

The description of the item.

metadataobject

The metadata of the item.

matchedLetterstring

The ID of a letter to match this test item to.

Response

The request has succeeded and a new resource has been created as a result.

idstring required

A unique ID prefixed with virtual_mailbox_item_

descriptionstring

An optional string describing this resource. Will be visible in the API and the dashboard.

metadataobject

See the section on Metadata.

liveboolean required

true if this is a live mode resource else false.

createdAtstring date-time required

The UTC time at which this resource was created.

updatedAtstring date-time required

The UTC time at which this resource was last updated.

object'virtual_mailbox_item' required

Always "virtual_mailbox_item".

virtualMailboxstring required

The ID of the virtual mailbox associated with this item.

fileURLstring

A URL of the envelope scan PDF.

matchedLetterstring

The ID of the letter this item was matched to.

Changes