Virtual Mailboxes

Create Virtual Mailbox

Changed on

Creates a new virtual mailbox. In live mode, the virtual mailbox will be pending assignment and cannot be used until it has been assigned and activated by our team. You will be notified via email once the virtual mailbox has been activated. In test mode, the virtual mailbox will be activated immediately upon creation.

post/print-mail/v1/virtual_mailboxes

Request

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

Request body

countryCode'US' required

All of the supported countries for virtual mailboxes.

Response

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

idstring required

A unique ID prefixed with virtual_mailbox_

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' required

Always "virtual_mailbox".

status'active' | 'pending_assignment' required

The possible statuses of virtual mailboxes.

countryCode'US' required

All of the supported countries for virtual mailboxes.

Changes

  • 54cf11f8a76fRevision changes
    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the optional property ////////// to the response with the status

  • c8fedcbd705eRevision changes
    • info

      endpoint added