Letters

Progress Status

Changed on

Progresses a letter's status to the next stage. This is only available in test mode and can be used to simulate how a live order would progress through the different statuses.

Note: this will fail with an invalid_progression_error if the status is one of completed or cancelled.

post/print-mail/v1/letters/{id}/progressions

Request

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

Path parameters

idstring required

The ID of the letter you want to progress.

Response

The progressed letter

status'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled' required
mergeVariablesobject

These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.

trackingNumberstring

The tracking number of this order. Populated after an express/certified order has been processed for delivery.

imbStatus'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender'
imbZIPCodestring

The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.

imbDatestring date-time

The last date that the IMB status was updated. See imbStatus for more details.

urlstring uri

PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.

This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.

idstring required

A unique ID prefixed with letter_

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.

sendDatestring date-time required

This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.

mailingClass'first_class' | 'standard_class' | 'express' | 'certified' | 'certified_return_receipt' | 'registered' | 'usps_first_class' | 'usps_standard_class' | 'usps_eddm' | 'usps_express_2_day' | 'usps_express_3_day' | 'usps_first_class_certified' | 'usps_first_class_certified_return_receipt' | 'usps_first_class_registered' | 'usps_express_3_day_signature_confirmation' | 'usps_express_3_day_certified' | 'usps_express_3_day_certified_return_receipt' | 'ca_post_lettermail' | 'ca_post_personalized' | 'ca_post_neighbourhood_mail' | 'ups_express_overnight' | 'ups_express_2_day' | 'ups_express_3_day' | 'royal_mail_first_class' | 'royal_mail_second_class' | 'au_post_second_class' required
object'letter' required

Always letter.

perforatedPage1

If specified, indicates which letter page is perforated. Currently, only the first page can be perforated.

returnEnvelopestring

The return envelope (ID) sent out with the letter, if any.

pdfWorkflowRunstring

The ID of the PDF workflow run that created the letter, if any.

doubleSidedboolean required

Indicates if the letter is double-sided.

colorboolean required

Indicates if the letter is in color.

size'us_letter' | 'a4' required

Enum representing the supported letter sizes.

addressPlacement'top_first_page' | 'insert_blank_page' required

Enum representing the placement of the address on the letter.

envelopestring required

The envelope (ID) for the letter or the default standard envelope.

htmlstring

The HTML content for the letter. You can supply either this or template but not both.

templatestring

The template ID used for the letter. You can supply either this or html but not both.

uploadedPDFstring uri

If a PDF was uploaded for the letter, this will contain the signed link to the uploaded PDF.

Changes

  • 537d2bbc624aRevision changes
    • breaking

      added subschema #1 to the ///// response property oneOf list for the response status

    • breaking

      added subschema #1 to the ////////// response property oneOf list for the response status

    • breaking

      added subschema #1 to the ////////// response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the ///// response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the ////////// response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the ////////// response property anyOf list for the response status

  • 54cf11f8a76fRevision changes
    • info

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

    • info

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