Virtual Mailboxes

Retrieve Virtual Mailbox

Changed on
get/print-mail/v1/virtual_mailboxes/{id}

Request

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

Path parameters

idstring required

Response

The request has succeeded.

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 optional property ////////// to the response with the status

  • c8fedcbd705eRevision changes
    • info

      endpoint added