POpostgrid
Letters

Get Letter Preview

Retrieve a letter preview URL.

This is only available for customers with our document management addon, which offers document generation and hosting capabilities. This endpoint has a much higher rate limit than the regular order retrieval endpoint, so it is suitable for customer-facing use-cases.

get/print-mail/v1/letters/{id}/url

Request

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

Path parameters

idstring required

The ID of the letter to retrieve the preview URL for.

Response

the Letter Preview URL.

idstring required

A unique ID prefixed with letter_

objectstring required
urlstring uri required

A signed URL linking to the order preview PDF. The link remains valid for 15 minutes from the time of the API call.

Changes

No recorded changes to this operation across all 1 revision of this API.