A simple API to send letters, postcards, and cheques. You can integrate this API to automate your transactional mailings and/or provide offline sending capabilities to your users.
\nIf you just want to perform one-off sends, you can also do so directly from the API dashboard at https://dashboard.postgrid.com
\nTake a look at our guides for information on how to get started.
\nEvery user in your organization will be provided 2 API keys which they can access from their settings: the test key and the live key. Any API calls made with the test key operate in an isolated sandbox. None of the resources you manage in test mode will affect your live environment, and vice versa.
\nYou can try out your integration using the test API keys. There is no difference other than the fact that we do not verify addresses in test mode. Also, more importantly, none of the orders made in test mode will be sent out. Once you've tested your integration, you can switch to the live API key and it will just work.
\nTest orders will also transition from ready to completed at the same time (equivalent) live orders would transition into printing.
There are two primary ways of providing printable content to this API: you can either send predesigned PDFs or provide HTML with personalizable variables. In either case, the address information will automatically be stamped on the final mailing.
\nFor letters, the destination and return addresses are stamped on the first page of your mailing by default. Refer to the following table:
\nPostGrid will automatically cancel orders if it detects that there is content underneath the address region. If you are not able to accommodate the address region in your design, you can also insert a blank page just for the address via the letters API addressPlacement parameter.
If you have the plastic card inserts feature enabled, your plastic card templates/PDF files must follow the following guideline: Click here.
\nFor postcards, the guideline varies depending on size and country. Refer to the following table
\nCanada:
\nUnited Kingdom & Europe:
\nNote that for the UK postcards, the red zone's width is half the width of the postcard itself.
\nUS & International:
\nFor cheques, the message HTML can cover 7 inches from the top of the first page to the top of the cheque. There is a 0.3in margin applied to this message as it is required for optimal printing.
For self mailers, the guideline varies depending on the size/type of self mailer you're sending:
\nUS & International:
\nClick here to get access to our Zapier integration. Zapier will enable you to connect over 1300 apps with PostGrid's print & mail capabilities without writing any code.
\nEvery order contains a status field with one of the following values
See the intelligent-mail tracking section below for more detailed tracking information that we provide in the US.
\nLive orders destined for the US have an imbStatus field added to them once they are processed at a USPS facility. This field has one of the following values
Additionally, the fields imbDate and imbZIPCode are included to provide more details about the mailing's journey.
The imbDate represents the date when the mailing was last scanned at a USPS facility, and the imbZIPCode indicates the postal code of that facility. These fields are updated as your order progresses through the USPS processing stages.
By default, all mail is sent as First Class or the fastest non-express postage available in the destination country. You can override this by supplying a specific mailingClass value. For instance, for a lower postage you can supply a mailingClass parameter with value of standard_class to your API calls.
The table below is an exhaustive list of the possible mailingClass values.
By default, the letter size will be chosen based on the destination country. You can override this to get a specific letter size by supplying a size parameter with one of the other size options us_letter, us_legal, a4.
By default, the cheque size will be chosen based on the destination country. You can override this to get a specific cheque size by supplying a size parameter with one of the other size options us_letter or us_legal.
You can cancel orders while they are still in the ready status. For orders scheduled in advance, this typically means you can cancel them until 12AM eastern time on its sendDate. For orders that are scheduled to send ASAP, you should be able to cancel until 12AM eastern time on the following day.
For example, if I create an order without a sendDate (i.e. send ASAP) at 3PM eastern time on 2020-09-14, I can cancel it until 12AM eastern time on 2020-09-15.
All requests here can be authorized via an x-api-key header. If you're using cURL, you can also supply the key using the shorthand -u YOUR_API_KEY:
You can retrieve your API key from the dashboard inside the Settings page.
All request bodies can be specified in application/json or application/x-www-form-urlencoded. For the endpoints that require uploading a file, you can supply the body as multipart/form-data.
Note that the examples here use the URL encoded format. However, this maps easily into JSON. Wherever you see e.g. to[addressLine1]=Example, that's equivalent to
\"to\": { \"addressLine1\": \"Example\" }\n\nin JSON.
\nWe have different rate limits depending on the type of request.
\nFor orders (letters, postcards, cheques, self mailers, boxes) and resources (contacts, templates, bank accounts, return envelopes, trackers).
\nIf you do exceed our rate limit we will return a 429 status code. We recommend using an exponential backoff with jitter retry strategy along with making use of our idempotent requests feature.
\nOur API supports idempotence on our order creation endpoints. This allows you to safely retry API calls without creating duplicate orders. This also makes your code more robust in the presence of network issues which disrupt API calls. As such, we highly recommend you make use of this feature.
\nIn order to make your order creation calls idempotent, you must supply an additional Idempotency-Key: header. If your request validates successfully, we will ensure that subsequent requests with an identical idempotency key made up to 24 hours after the initial will return the exact same response without creating any orders. This includes error responses.
You are free to generate your keys however you like, but we suggest using V4 UUIDs.
\nAll of our error responses contain an error top-level object. This is what it looks like.
PostGrid uses standard HTTP codes to indicate successful or failed API requests. Successful operations will return 2xx codes. Responses with 4xx codes usually indicate input errors and 5xx codes indicate a server error.
\nPlease refer to the documentation below for more details.
\nAll of our listing endpoints are paginated and produce responses according to the List schema. These endpoints receive a skip and limit parameter which can be used to traverse the pages. You can traverse a complete list by incrementing skip by limit for each request until skip >= totalCount, where totalCount is returned in the list response.
Our resource listing endpoints such as GET /contacts and GET /letters provide advanced search capabilities. You can perform this search via a search query parameter, or use the search field on our dashboard.
For example GET /v1/contacts?search=\"New York\" (i.e. search=\"New York\") will produce all the contacts that have the exact string \"New York\" in their body.
You can also perform structured queries like GET /v1/letters?search={\"metadata.campaignID\": \"ABC\"} which searches for
{\n \"metadata.campaignID\": \"ABC\"\n}\n\nIn other words, this will produce all the letters whose campaignID matches ABC.
Some of our endpoints return resources with nested IDs. For example, when you retrieve a letter that was created from a template, its body will contain the template ID (See Letter). Rather than making a separate API request for the nested template, you can pass along an query parameter like GET /letters?expand[]=template.
This also works for getting the nested bankAccount inside a cheque. However, it is important to note that you cannot do this for the listing endpoints due to its performance implications.
Every object in the API can have arbitrary metadata attached to it. For example, I can tag my letters with a campaign ID:
{\n // Other letter fields...\n \"metadata\": {\n \"campaignID\": \"ABC\"\n }\n}\n\nI can later get analytics on these letters using the advanced search functionality in the dashboard.
\nThe metadata object must not exceed 10kb of uncompressed storage.
\nWhenever you supply HTML to the API via a Template, directly inside a Letter, Postcard, or in the message of a Cheque, you can specify variable fields using curly braces like {{variableName}}. You can then supply a mergeVariables object in your POST requests, and provide values for them.
mergeVariables on a request can contain arbitrarily nested objects. For example
{\n \"income\": {\n \"beforeTax\": 100,\n \"afterTax\": 73\n }\n}\n\nand these can be referenced by using a . to access nested fields {{income.beforeTax}} and {{income.afterTax}}. Note that variable names (e.g. income, beforeTax, afterTax) cannot contain the characters , # $ .
You can also access the following predefined merge variables in your template
\nWe provide PDF previews for all orders (including those created in test mode). These previews should be generated a few seconds after you create an order. They can be accessed through the url property of the returned objects or on the dashboard by clicking View PDF on the top-right of the order details page.
In the case of cheques, the previews will censor the account number by padding the last 4 digits of the account number with zeros.
\nYou can provide an extraService parameter to the Letter and Cheque creation endpoints. This parameter will allow you to send certified/registered mail (including certified mail with return receipts). This is currently only available for US mailings. Note that additional charges will apply for these mailings.
Once a tracking number has been generated, a letter.updated or cheque.updated event will be generated and a webhook will be triggered with the trackingNumber field present. It can be retrieved through a GET request or via the raw data in the dashboard. Using this tracking number, you can view the delivery status of the order on the USPS website or using their API.
Here are the possible values you can provide for extraService
You can also supply specific values to mailingClass to extra service for your orders.
\nYou can request that the first page of a letter is perforated by adding a parameter perforatedPage: 1 to your letters POST request body. The perforation will be done such that the bottom 3rd of the page (3.6 inches from the bottom) can be torn off the letter.
You can send your letters along with a return envelope by supplying a returnEnvelope ID to your POST /letters or POST /cheques API call. Note that you must first order return envelopes using our Return Envelopes API (see the relevant sections).
On select resources, providing a secret parameter allows hiding information from the dashboard and API. This allows external and private information to be used in the final prints without allowing PostGrid users to view this information. The provided resource ID can be used as a token to allow using these secret resources without giving access to their underlying data.
In the event that one of the recipients you've mailed to has moved from the address you supplied, PostGrid may redirect the mail to their new address (depending on your subscription tier).
\nIf mail is redirected, the address changes are applied directly to the affected contacts/orders within our API and dashboard. This also issues a webhook {order_type}.updated event where {order_type} is one of letter, postcard, cheque, or self_mailer depending on which type of order was updated.
You can examine the new address by looking at the addressLine1, addressLine2, etc. fields of the contacts. There is also a new addressChange object that gets added to contacts that have changed as a result of a move. See the following for the schema of this object.
You can request express shipping for your orders by setting specific options in mailingClass. See Mailing Class for more details.
PostGrid can provide the exact status of an order as provided by the underlying mail carrier when an appropriate mailingClass is used (e.g. USPS certified mail). You can learn more about this feature here: https://postgrid.readme.io/reference/carrier-tracking
The first name of the contact.
\nThis field is optional if a companyName is being supplied. If no companyName is supplied then this field is required
The last name of the contact.
\noptional
The contact's company name.
\nThis field is optional if a firstName is being supplied. If no firstName is supplied then this field is required.
The contact's first address line.
\nrequired
The contact's second address line.
\noptional
The contact's city.
\noptional
The province or state of the contact.
\noptional
The contact's email.
\noptional
The contact's phone number.
\noptional
The contact's job title.
\noptional
The postal code or ZIP code of the contact.
\noptional
The ISO 3611-1 country code of the contact's address. Defaults to CA
optional deprecated
The ISO 3611-1 country code of the contact's address. Defaults to CA.
required
A description for the contact.
\noptional
See metadata.
\noptional
If true, skip address verification and mark the address as failed.
optional
If true, force the status of the address to be verified, effectively whitelisting it even if our address verification system would otherwise fail it.
\n","type":"text"}]},"url":"https://api.postgrid.com/print-mail/v1/contacts","description":"Creates a new contact. Will also verify the address if created with the live API key. To successfully create a contact, either a firstName, companyName, or both is required. You can supply both, but you cannot supply neither.
Note that if you create a contact that has identical information to another contact, this will simply update the description of the existing contact and return it. This avoids creating duplicate contacts.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"The first name of the contact.
\nThis field is optional if a companyName is being supplied. If no companyName is supplied then this field is required
The last name of the contact.
\noptional
The contact's company name.
\nThis field is optional if a firstName is being supplied. If no firstName is supplied then this field is required.
The contact's first address line.
\nrequired
The contact's second address line.
\noptional
The contact's city.
\noptional
The province or state of the contact.
\noptional
The contact's email.
\noptional
The contact's phone number.
\noptional
The contact's job title.
\noptional
The postal code or ZIP code of the contact.
\noptional
The ISO 3611-1 country code of the contact's address. Defaults to CA
optional deprecated
The ISO 3611-1 country code of the contact's address. Defaults to CA.
required
A description for the contact.
\noptional
See metadata.
\noptional
If true, skip address verification and mark the address as failed.
optional
If true, force the status of the address to be verified, effectively whitelisting it even if our address verification system would otherwise fail it.
\n","type":"text"},{"key":"secret","value":"true","type":"text"}]},"url":"https://api.postgrid.com/print-mail/v1/contacts","description":"Creates a new contact. Will also verify the address if created with the live API key. To successfully create a contact, either a firstName, companyName, or both is required. You can supply both, but you cannot supply neither.
Note that if you create a contact that has identical information to another contact, this will simply update the description of the existing contact and return it. This avoids creating duplicate contacts.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"The contact's first name.
\nThis field is optional if a companyName is being supplied. If no companyName is supplied then this field is required
The contact's last name.
\noptional
The contact's company name.
\nThis field is optional if a firstName is being supplied. If no firstName is supplied then this field is required
The ISO 3611-1 country code of the contact's address. Defaults to CA.
required
The contact's full address.
\nrequired
The contact's email.
\noptional
The contact's job title.
\noptional
The contact's phone number.
\noptional
A description for the contact.
\noptional
See metadata.
\noptional
The ISO 3611-1 country code of the contact's address. Defaults to CA.
optional deprecated
If true, skip address verification and mark the address as failed.
optional
Create a contact where the address of the contact is provided in a single line. PostGrid will automatically parse this address, and will verify/correct it in live mode.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"Retrieve a list of all of the contacts of the user's current organization.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"Used for traversing pages. See lists and pagination.
\noptional
Limits the number of resources returned. See lists and pagination.
\noptional
Searches the data for the given input. See search.
\noptional
Gets the information for a specific contact with the corresponding id. The id for the contact. This should be a unique identifying string starting with contact_.
The contact's id.
required
Removes a contact with the corresponding id. The id for the contact. This should be a unique identifying string starting with contact_.
Removes the contact by id.
required
Manage contacts that you can mail to. Test mode addresses will always have a verified status. In live mode, they may be verified, corrected, or failed. Addresses that fail to be corrected are likely undeliverable, but you can still send to them if you want to.
For test mode contacts, you have the ability to assert the addressStatus of the contact by passing specific values to the description field. To receive an addressStatus of failed, the description of the contact should be a string with the exact value test failed. For an addressStatus value of corrected, the description of the contact should be a string with the exact value test corrected.
Our address correction engine will often be able to fix missing postal/ZIP codes, city names, and also append ZIP+4. It is SERP (Canada Post) and CASS (USPS) certified, so you can rest assured that if an address is verified, we can deliver to it.
\nThe HTML content for the template.
\nrequired
A description for the template.
\noptional
See metadata.
\noptional
Creates a new template.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"Gets the specified template by id. The id for the template. This should be a unique identifying string starting with template_.
The id of the template.
required
Gets a list of templates associated with the users organization.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"Used for traversing pages. See lists and pagination.
\noptional
Limits the number of resources returned. See lists and pagination.
\noptional
Searches the data for the given input. See search.
\noptional
The HTML content for the template.
\nrequired
A description for the template.
\noptional
See metadata.
\noptional
Updates a template based on the passed id. The id for the template. This should be a unique identifying string starting with template_.
The id of the template to update.
required
Deletes the specified template by id. The id for the template. This should be a unique identifying string starting with template_.
The id of the template to delete.
required
The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
required
The HTML content of the letter.
\nrequired
The location where the address will be placed. Must be either top_first_page or insert_blank_page.
optional
Indicates if the letter is double sided or not.
\noptional\nDefault: false
Indicates whether the letter will be printed in color or not.
\noptional\nDefault: false
Indicates which page is to be perforated. Currently the only valid value is 1 (the first page).
optional
Indicates extra services for the letter. See certified and registered mail.
\noptional
The ID of the custom envelope your organization has, if applicable.If you are interested in using custom envelopes but do not yet have one, please contact PostGrid support for assistance.
\nIf this parameter is not provided, the default standard envelope (standard double window) will be used.\noptional
The id of the return envelope to be used.
optional
The desired date for the letter to be sent out.
\noptional
A description for the letter.
\noptional
See express shipping.
\n","type":"text"},{"key":"mergeVariables[language]","value":"english","description":"See merge variables.
\noptional
See metadata.
\noptional
Defaults to first_class. See mailing class.
optional
Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See letter size
\noptional
Create a letter order using HTML.
\n","urlObject":{"path":["v1","letters"],"host":["https://api.postgrid.com/print-mail"],"query":[],"variable":[]}},"response":[{"id":"27e78101-78ee-4b13-8d6e-2730e9e8b087","name":"Create Letter","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"to[firstName]","value":"Kevin","type":"text"},{"key":"to[companyName]","value":"PostGrid","type":"text"},{"key":"to[addressLine1]","value":"20-20 bay st","type":"text"},{"key":"to[addressLine2]","value":"floor 11","type":"text"},{"key":"to[city]","value":"Toronto","type":"text"},{"key":"from[firstName]","value":"Apaar","type":"text"},{"key":"from[companyName]","value":"PostGrid","type":"text"},{"key":"from[addressLine1]","value":"20-20 bay st","type":"text"},{"key":"from[addressLine2]","value":"floor 11","type":"text"},{"key":"from[city]","value":"toronto","type":"text"},{"key":"html","value":"Hello, {{to.firstName}}!","type":"text"}],"options":{"raw":{"language":"json"}}},"url":"https://api.postgrid.com/print-mail/v1/letters"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"862"},{"key":"ETag","value":"W/\"35e-5XCVr+H+jN6ZQi4Gdg6L0kKU4cw\""},{"key":"Date","value":"Thu, 12 Nov 2020 23:30:12 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"letter_b2friz2FYMzHAUmDuZfy1F\",\n \"object\": \"letter\",\n \"live\": false,\n \"addressPlacement\": \"top_first_page\",\n \"from\": {\n \"id\": \"contact_dk6G7aFruyzTfAMzDstUBp\",\n \"object\": \"contact\",\n \"addressLine1\": \"20-20 BAY ST FLOOR 11\",\n \"addressLine2\": \"\",\n \"addressStatus\": \"corrected\",\n \"city\": \"TORONTO\",\n \"companyName\": \"PostGrid\",\n \"country\": \"CANADA\",\n \"countryCode\": \"CA\",\n \"firstName\": \"Apaar\",\n \"postalOrZip\": \"M5J2N8\",\n \"provinceOrState\": \"ON\"\n },\n \"html\": \"Hello, {{to.firstName}}!\",\n \"sendDate\": \"Thu Nov 12 2020\",\n \"status\": \"ready\",\n \"to\": {\n \"id\": \"contact_qCpdmxgNV37pCoENhoCrPH\",\n \"object\": \"contact\",\n \"addressLine1\": \"20-20 BAY ST FLOOR 11\",\n \"addressLine2\": \"\",\n \"addressStatus\": \"corrected\",\n \"city\": \"TORONTO\",\n \"companyName\": \"PostGrid\",\n \"country\": \"CANADA\",\n \"countryCode\": \"CA\",\n \"firstName\": \"Kevin\",\n \"postalOrZip\": \"M5J2N8\",\n \"provinceOrState\": \"ON\"\n },\n \"createdAt\": \"2020-11-12T23:30:12.581Z\",\n \"updatedAt\": \"2020-11-12T23:30:12.581Z\"\n}"}],"_postman_id":"3359155b-f225-4f6a-b08a-eafe7a52b54d"},{"name":"Create Letter With Full Contact Info","id":"18751301-01b1-4403-bf35-75baeda37c15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"to[addressLine1]","value":"20-20 BAY ST","type":"text","description":"Receiving contact's first line of address.
\nrequired
Receiving contact's first name. This field is optional if a companyName is being supplied. If no companyName is supplied then this field is required
Receiving contact's last name.
\noptional
Receiving contact's company name. This field is optional if a firstName is being supplied. If no firstName is supplied then this field is required
The receiving contact's city.
\noptional
Receiving contacts postal code or ZIP code.
\noptional
Receiving contacts province or state.
\noptional
The ISO 3611-1 country code of the receiving contact's address.
\noptional
Whether we want to skip address verification for this contact. Defaults to false.
optional
Sending contact's first line of address.\nrequired
The sending contact's city.\noptional
Sending contact's company name. This field is optional if a firstName is being supplied. If no firstName is supplied then this field is required.
Sending contact's first name. This field is optional if a companyName is being supplied. If no companyName is supplied then this field is required
Sending contact's last name.\noptional
Sending contacts postal code or ZIP code.\noptional
Sending contacts province or state.\noptional
The ISO 3611-1 country code of the sending contact's address.
\noptional
The HTML content of the letter.\nrequired
The location where the address will be placed. Must be either top_first_page or insert_blank_page.\noptional
Indicates if the letter is double sided or not.\noptional\nDefault: false
Indicates whether the letter will be printed in color or not.\noptional
Indicates if the page is to be perforated (holes). 1 denotes true.\noptional
Indicates extra services for the letter. See certified and registered mail.\noptional
The ID of the custom envelope your organization has, if applicable.If you are interested in using custom envelopes but do not yet have one, please contact PostGrid support for assistance.
\nIf this parameter is not provided, the default standard envelope (standard double window) will be used.\noptional
The id of the return envelope to be used.\noptional
The desired date for the letter to be sent out.\noptional
A description for the letter.\noptional
See express shipping.
\n"},{"key":"mailingClass","value":"first_class","type":"text","description":"Defaults to first_class. See mailing class.\noptional
See merge variables.\noptional
See metadata.\noptional
Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See letter size\noptional
Create a letter order using HTML while providing a contact object to both from and to. This can be done while sending templates, uploaded PDFs or PDF links. This simply demonstrates an alternative to passing the from and to contact's id.
The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
required
The template's id to be used for the letter.
required
The location where the address will be placed. Must be either top_first_page or insert_blank_page.
optional
Indicates if the letter is double sided or not.\noptional\nDefault: false
Indicates whether the letter will be printed in color or not.
\noptional
Indicates if the page is to be perforated (holes). 1 denotes true.
optional
Indicates extra services for the letter. See certified and registered mail.
\noptional
The ID of the custom envelope your organization has, if applicable.If you are interested in using custom envelopes but do not yet have one, please contact PostGrid support for assistance.
\nIf this parameter is not provided, the default standard envelope (standard double window) will be used.\noptional
The id of the return envelope to be used.
optional
The desired date for the letter to be sent out.
\noptional
See express shipping.
\n","type":"text"},{"key":"description","value":"My template letter","description":"A description for the letter.
\noptional
Defaults to first_class. See mailing class.
optional
See merge variables.
\noptional
See metadata.
\noptional
Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See letter size\noptional
Create a letter order using a preexisting template.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"The id or contact object of the receiver. You can either pass a contact object or a contact's id.\nrequired
The id or contact object of the sender. You can either pass a contact object or a contact's id.\nrequired
The template's id to be used for the letter.\nrequired
The location where the address will be placed. Must be either top_first_page or insert_blank_page.\noptional
Indicates if the letter is double sided or not.\noptional\nDefault: false
Indicates whether the letter will be printed in color or not.\noptional
Indicates which page should be perforated. If supplied, the value must be 1 meaning perforate the first page.
optional
Indicates extra services for the letter. See certified and registered mail.\noptional
The ID of the custom envelope your organization has, if applicable.If you are interested in using custom envelopes but do not yet have one, please contact PostGrid support for assistance.
\nIf this parameter is not provided, the default standard envelope (standard double window) will be used.\noptional
The id of the return envelope to be used.\noptional
The desired date for the letter to be sent out.
\noptional
See express shipping.
\n"},{"key":"description","value":"Template with attached PDF","type":"text","description":"A description for the letter.
\noptional
Defaults to first_class. See mailing class.\noptional
Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See letter size
\noptional
One of either before_template (the attached PDF will be placed before the template) or after_template (the attached PDF will be placed after the template).
The PDF file you would like to attach. Can be supplied via form data upload, a publically accessible link to a peformant file host (e.g. AWS S3), or a base64-encoded data URL.
\n","value":"https://www.africau.edu/images/default/sample.pdf"}]},"url":"https://api.postgrid.com/print-mail/v1/letters","description":"Create a letter order with an HTML template and attach a PDF file before/after the template.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
required
The PDF file to be used for the letter.
\nrequired
The location where the address will be placed. Must be either top_first_page or insert_blank_page.
optional
Indicates if the letter is double sided or not.\noptional\nDefault: false
Indicates whether the letter will be printed in color or not.
\noptional
Indicates if the page is to be perforated (holes). 1 denotes true.
optional
Indicates extra services for the letter. See certified and registered mail.
\noptional
The ID of the custom envelope your organization has, if applicable.If you are interested in using custom envelopes but do not yet have one, please contact PostGrid support for assistance.
\nIf this parameter is not provided, the default standard envelope (standard double window) will be used.\noptional
The id of the return envelope to be used.
optional
The desired date for the letter to be sent out.
\noptional
See express shipping.
\n","type":"text"},{"key":"description","value":"My PDF file letter","description":"A description for the letter.
\noptional
Defaults to first_class. See mailing class.
optional
see merge variables.
\noptional
See metadata.
\noptional
Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See letter size\noptional
Directly upload a PDF to be stamped and sent out.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
required
A publicly accessible URL of a PDF to be used for the letter.
\nrequired
The location where the address will be placed. Must be either top_first_page or insert_blank_page.
optional
Indicates if the letter is double sided or not.\noptional\nDefault: false
Indicates whether the letter will be printed in color or not.
\noptional
Indicates if the page is to be perforated (holes). 1 denotes true.
optional
Indicates extra services for the letter. See certified and registered mail.
\noptional
The ID of the custom envelope your organization has, if applicable.If you are interested in using custom envelopes but do not yet have one, please contact PostGrid support for assistance.
\nIf this parameter is not provided, the default standard envelope (standard double window) will be used.\noptional
The id of the return envelope to be used.
optional
The desired date for the letter to be sent out.
\noptional
A description for the letter.
\noptional
See express shipping.
\n","type":"text"},{"key":"mailingClass","value":"first_class","description":"Defaults to first_class. See mailing class.
optional
See merge variables.
\noptional
See metadata.
\noptional
Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See letter size\noptional
Create a letter with a link to a PDF hosted somewhere publicly accessible.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"Gets the specified letter by id. This should be a unique identifying string starting with letter_.
Must be either template or returnEnvelope. See expansions.
optional
The id of the desired letter.
required
Get all the letter orders you've created.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"Used for traversing pages. See lists and pagination.
\noptional
Limits the number of resources returned. \n See lists and pagination.
\noptional
Searches the data for the given input. See search.
\noptional
Cancels the specified letter by id. This should be a unique identifying string starting with letter_.
The id of the letter to be deleted.
required
A note for the cancellation of the letter.\nrequired
Cancels the specified letter by id with a note describing the reason for cancellation. The id should be a unique identifying string starting with letter_. The note should be a string.
The id of the letter to be deleted.
required
Progress the desired test letter by id to the next status. This should be a unique identifying string starting with letter_. This can be used to test webhooks.
Note: that this will fail with an invalid_progression_error if the status is one of completed or cancelled.
The id of the letter to be progressed.
required
Create and manage letter orders.
\nGet all the letter orders you've created.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"Used for traversing pages. See lists and pagination.
\noptional
Limits the number of resources returned. \n See lists and pagination.
\noptional
Searches the data for the given input. See search.
\noptional
Create and manage box orders.
\nThe id or contact object of the receiver. You can either pass a contact object or a contact's id.\nrequired
The id or contact object of the sender. You can either pass a contact object or a contact's id.\nrequired
The template's id to be used for the letter.\nrequired
The location where the address will be placed. Must be either top_first_page or insert_blank_page.\noptional
Indicates if the letter is double sided or not.\noptional\nDefault: false
Indicates whether the letter will be printed in color or not.\noptional
Indicates which page should be perforated. If supplied, the value must be 1 meaning perforate the first page.
optional
Indicates extra services for the letter. See certified and registered mail.\noptional
Indicates the envelope type for the letter. Must be either standard_double_window or flat.\noptional
The id of the return envelope to be used.\noptional
The desired date for the letter to be sent out.
\noptional
See express shipping.
\n"},{"key":"description","value":"Template with attached PDF","type":"text","description":"A description for the letter.
\noptional
Defaults to first_class. See mailing class.\noptional
Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See letter size
\noptional
The link to the PDF to be used for the plastic card.
\nrequired
Size of plastic card
\nrequired
Create a letter order with an HTML template and attach a PDF file before/after the template.
\n","urlObject":{"path":["v1","letters"],"host":["https://api.postgrid.com/print-mail"],"query":[],"variable":[]}},"response":[{"id":"26684fe6-88b7-4140-8663-79a01e9d11dd","name":"Create Letter with Single-Sided Plastic Card from PDF Link","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"to","value":"contact_8v1mibdKkpK8Si6vz7xBVi","type":"text","description":"The `id` or [contact](#contact) `object` of the receiver. You can either pass a contact `object` or a contact's `id`.\n`required`"},{"key":"from","value":"contact_8v1mibdKkpK8Si6vz7xBVi","type":"text","description":"The `id` or [contact](#contact) `object` of the sender. You can either pass a contact `object` or a contact's `id`.\n`required`"},{"key":"template","value":"template_5n7fprLVnDDsULzhguWBaZ","type":"text","description":"The template's `id` to be used for the letter.\n`required`"},{"key":"addressPlacement","value":"top_first_page","type":"text","description":"The location where the address will be placed. Must be either `top_first_page` or `insert_blank_page`.\n`optional`"},{"key":"doubleSided","value":"true","type":"text","description":"Indicates if the letter is double sided or not.\n`optional`\nDefault: `false`"},{"key":"color","value":"false","type":"text","description":"Indicates whether the letter will be printed in color or not.\n`optional`"},{"key":"perforatedPage","value":"1","type":"text","description":"Indicates which page should be perforated. If supplied, the value must be `1` meaning perforate the first page.\n\n`optional`","disabled":true},{"key":"extraService","value":"certified","type":"text","description":"Indicates extra services for the letter. See [certified and registered mail](#certified-and-registered-mail).\n`optional`"},{"key":"envelopeType","value":"flat","type":"text","description":"Indicates the envelope type for the letter. Must be either `standard_double_window` or `flat`.\n`optional`","disabled":true},{"key":"returnEnvelope","value":"return_envelope_97Tcv1LxhWWLPUvn58CuVJ","type":"text","description":"The `id` of the [return envelope](#return-envelope) to be used.\n`optional`","disabled":true},{"key":"sendDate","value":"2023-02-16T15:40:35.873Z","type":"text","description":"The desired date for the letter to be sent out.\n\n`optional`","disabled":true},{"key":"express","value":"false","type":"text","description":"See [express shipping](#express-shipping)."},{"key":"description","value":"Template with attached PDF","type":"text","description":"A description for the letter.\n\n`optional`"},{"key":"mailingClass","value":"first_class","type":"text","description":"Defaults to `first_class`. See [mailing class](#mailing-class).\n`optional`","disabled":true},{"key":"mergeVariables[language]","value":"english","type":"text"},{"key":"metadata[company]","value":"PostGrid","type":"text"},{"key":"size","value":"us_letter","type":"text","description":"Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See [letter size](#letter-size)\n\n`optional`"},{"key":"plasticCard[singleSided][pdf]","value":"https://eksandbox.s3.amazonaws.com/files/plastic_card_ex.pdf","description":"The link to the PDF to be used for the plastic card.\n\n`required`","type":"text"},{"key":"plasticCard[size]","value":"standard","description":"Size of plastic card\n\n`required`","type":"text"}]},"url":"https://api.postgrid.com/print-mail/v1/letters"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2024 15:25:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1404"},{"key":"Connection","value":"keep-alive"},{"key":"strict-transport-security","value":"max-age=63072000; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"content-security-policy","value":"default-src 'none'"},{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"etag","value":"W/\"57c-8MHWRDNpycOszDV7XyF74DwYFpo\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=B%2B8P6Jwc17A9MFARSdd%2B2YFany0232%2FjZ1eQG0rKoQoRcjwXClUnURdqgtRE1YNg3slz4bsoDii6fE0NxL6i88667S0wA3LqZe0oHqgoxQpsSSBGW3coFg5532AUTgbIbIDL\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8b7c1ce8fbdac946-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"letter_9Mg6kcUjjFzMxGjwa3tvYi\",\n \"object\": \"letter\",\n \"live\": false,\n \"addressPlacement\": \"top_first_page\",\n \"attachedPDF\": null,\n \"carrierTracking\": null,\n \"color\": false,\n \"description\": \"Template with attached PDF\",\n \"doubleSided\": true,\n \"envelope\": \"standard\",\n \"envelopeType\": \"standard_double_window\",\n \"express\": false,\n \"extraService\": \"certified\",\n \"from\": {\n \"id\": \"contact_8v1mibdKkpK8Si6vz7xBVi\",\n \"object\": \"contact\",\n \"addressLine1\": \"20 MASS AVE\",\n \"addressLine2\": null,\n \"addressStatus\": \"verified\",\n \"city\": \"CAMBRIDGE\",\n \"country\": \"UNITED STATES\",\n \"countryCode\": \"US\",\n \"firstName\": \"Brian\",\n \"postalOrZip\": \"10013\",\n \"provinceOrState\": \"MA\"\n },\n \"mailingClass\": \"first_class\",\n \"mergeVariables\": {\n \"language\": \"english\"\n },\n \"metadata\": {\n \"company\": \"PostGrid\"\n },\n \"plasticCard\": {\n \"singleSided\": {\n \"uploadedPDF\": \"https://pg-prod-bucket-1.s3.amazonaws.com/test/pdf_7WxY5LKM6k5g7zwLZAoLgD?AWSAccessKeyId=AKIA5GFUILSULWTWCR64&Expires=1724427602&Signature=LTGln466IoGpuSoNTnUKXLf1ge8%3D\"\n },\n \"size\": \"standard\"\n },\n \"sendDate\": \"2024-08-23T15:25:02.700Z\",\n \"size\": \"us_letter\",\n \"status\": \"ready\",\n \"template\": \"template_5n7fprLVnDDsULzhguWBaZ\",\n \"to\": {\n \"id\": \"contact_8v1mibdKkpK8Si6vz7xBVi\",\n \"object\": \"contact\",\n \"addressLine1\": \"20 MASS AVE\",\n \"addressLine2\": null,\n \"addressStatus\": \"verified\",\n \"city\": \"CAMBRIDGE\",\n \"country\": \"UNITED STATES\",\n \"countryCode\": \"US\",\n \"firstName\": \"Brian\",\n \"postalOrZip\": \"10013\",\n \"provinceOrState\": \"MA\"\n },\n \"createdAt\": \"2024-08-23T15:25:02.704Z\",\n \"updatedAt\": \"2024-08-23T15:25:02.704Z\"\n}"}],"_postman_id":"cf52f5bc-e22e-4d79-9455-bcfb04e5ac35"},{"name":"Create Letter with Single-Sided Plastic Card from Uploaded PDF","id":"25d65a9e-b73e-417a-a4a5-4187a3b2ea0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"The id or contact object of the receiver. You can either pass a contact object or a contact's id.\nrequired
The id or contact object of the sender. You can either pass a contact object or a contact's id.\nrequired
The template's id to be used for the letter.\nrequired
The location where the address will be placed. Must be either top_first_page or insert_blank_page.\noptional
Indicates if the letter is double sided or not.\noptional\nDefault: false
Indicates whether the letter will be printed in color or not.\noptional
Indicates which page should be perforated. If supplied, the value must be 1 meaning perforate the first page.
optional
Indicates extra services for the letter. See certified and registered mail.\noptional
Indicates the envelope type for the letter. Must be either standard_double_window or flat.\noptional
The id of the return envelope to be used.\noptional
The desired date for the letter to be sent out.
\noptional
See express shipping.
\n"},{"key":"description","value":"Template with attached PDF","type":"text","description":"A description for the letter.
\noptional
Defaults to first_class. See mailing class.\noptional
Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See letter size
\noptional
The PDF to be used for the plastic card.
\nrequired
Size of plastic card
\nrequired
Create a letter order with an HTML template and attach a PDF file before/after the template.
\n","urlObject":{"path":["v1","letters"],"host":["https://api.postgrid.com/print-mail"],"query":[],"variable":[]}},"response":[{"id":"33077edf-b31a-41ef-b25c-e78448328529","name":"Create Letter with Single-Sided Plastic Card from Uploaded PDF","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"to","value":"contact_8v1mibdKkpK8Si6vz7xBVi","type":"text","description":"The `id` or [contact](#contact) `object` of the receiver. You can either pass a contact `object` or a contact's `id`.\n`required`"},{"key":"from","value":"contact_8v1mibdKkpK8Si6vz7xBVi","type":"text","description":"The `id` or [contact](#contact) `object` of the sender. You can either pass a contact `object` or a contact's `id`.\n`required`"},{"key":"template","value":"template_5n7fprLVnDDsULzhguWBaZ","type":"text","description":"The template's `id` to be used for the letter.\n`required`"},{"key":"addressPlacement","value":"top_first_page","type":"text","description":"The location where the address will be placed. Must be either `top_first_page` or `insert_blank_page`.\n`optional`"},{"key":"doubleSided","value":"true","type":"text","description":"Indicates if the letter is double sided or not.\n`optional`\nDefault: `false`"},{"key":"color","value":"false","type":"text","description":"Indicates whether the letter will be printed in color or not.\n`optional`"},{"key":"perforatedPage","value":"1","type":"text","description":"Indicates which page should be perforated. If supplied, the value must be `1` meaning perforate the first page.\n\n`optional`","disabled":true},{"key":"extraService","value":"certified","type":"text","description":"Indicates extra services for the letter. See [certified and registered mail](#certified-and-registered-mail).\n`optional`"},{"key":"envelopeType","value":"flat","type":"text","description":"Indicates the envelope type for the letter. Must be either `standard_double_window` or `flat`.\n`optional`","disabled":true},{"key":"returnEnvelope","value":"return_envelope_97Tcv1LxhWWLPUvn58CuVJ","type":"text","description":"The `id` of the [return envelope](#return-envelope) to be used.\n`optional`","disabled":true},{"key":"sendDate","value":"2023-02-16T15:40:35.873Z","type":"text","description":"The desired date for the letter to be sent out.\n\n`optional`","disabled":true},{"key":"express","value":"false","type":"text","description":"See [express shipping](#express-shipping)."},{"key":"description","value":"Template with attached PDF","type":"text","description":"A description for the letter.\n\n`optional`"},{"key":"mailingClass","value":"first_class","type":"text","description":"Defaults to `first_class`. See [mailing class](#mailing-class).\n`optional`","disabled":true},{"key":"mergeVariables[language]","value":"english","type":"text"},{"key":"metadata[company]","value":"PostGrid","type":"text"},{"key":"size","value":"us_letter","type":"text","description":"Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See [letter size](#letter-size)\n\n`optional`"},{"key":"plasticCard[singleSided][pdf]","description":"The PDF to be used for the plastic card.\n\n`required`","type":"file","src":"Mr_MiDa0X/plastic_card_ex.pdf"},{"key":"plasticCard[size]","description":"Size of plastic card\n\n`required`","type":"text","value":"standard"}]},"url":"https://api.postgrid.com/print-mail/v1/letters"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2024 15:27:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1406"},{"key":"Connection","value":"keep-alive"},{"key":"strict-transport-security","value":"max-age=63072000; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"content-security-policy","value":"default-src 'none'"},{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"etag","value":"W/\"57e-x1jze0xqrdDaWjFEesxBFXiOgHE\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=J3aUhuOIbiBPJI7XNZ84Y2JmXOYjgPVw%2BjNg1AVpjH46ZLJIM2dsdqth8EzYa%2FbRRzpGDXlanPNRMsaG6fCrXXfbhDgQHPKZMSO2f4JNwSfpKYVrAfACulMbbnpaYI2zddgp\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8b7c20d37c7e8242-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"letter_j9NVwaX8nkVsgeqSdetXo1\",\n \"object\": \"letter\",\n \"live\": false,\n \"addressPlacement\": \"top_first_page\",\n \"attachedPDF\": null,\n \"carrierTracking\": null,\n \"color\": false,\n \"description\": \"Template with attached PDF\",\n \"doubleSided\": true,\n \"envelope\": \"standard\",\n \"envelopeType\": \"standard_double_window\",\n \"express\": false,\n \"extraService\": \"certified\",\n \"from\": {\n \"id\": \"contact_8v1mibdKkpK8Si6vz7xBVi\",\n \"object\": \"contact\",\n \"addressLine1\": \"20 MASS AVE\",\n \"addressLine2\": null,\n \"addressStatus\": \"verified\",\n \"city\": \"CAMBRIDGE\",\n \"country\": \"UNITED STATES\",\n \"countryCode\": \"US\",\n \"firstName\": \"Brian\",\n \"postalOrZip\": \"10013\",\n \"provinceOrState\": \"MA\"\n },\n \"mailingClass\": \"first_class\",\n \"mergeVariables\": {\n \"language\": \"english\"\n },\n \"metadata\": {\n \"company\": \"PostGrid\"\n },\n \"plasticCard\": {\n \"singleSided\": {\n \"uploadedPDF\": \"https://pg-prod-bucket-1.s3.amazonaws.com/test/pdf_7WxY5LKM6k5g7zwLZAoLgD?AWSAccessKeyId=AKIA5GFUILSULWTWCR64&Expires=1724427762&Signature=b5PgE3da3lXBgN2kfvYX%2BN68Xyk%3D\"\n },\n \"size\": \"standard\"\n },\n \"sendDate\": \"2024-08-23T15:27:42.670Z\",\n \"size\": \"us_letter\",\n \"status\": \"ready\",\n \"template\": \"template_5n7fprLVnDDsULzhguWBaZ\",\n \"to\": {\n \"id\": \"contact_8v1mibdKkpK8Si6vz7xBVi\",\n \"object\": \"contact\",\n \"addressLine1\": \"20 MASS AVE\",\n \"addressLine2\": null,\n \"addressStatus\": \"verified\",\n \"city\": \"CAMBRIDGE\",\n \"country\": \"UNITED STATES\",\n \"countryCode\": \"US\",\n \"firstName\": \"Brian\",\n \"postalOrZip\": \"10013\",\n \"provinceOrState\": \"MA\"\n },\n \"createdAt\": \"2024-08-23T15:27:42.672Z\",\n \"updatedAt\": \"2024-08-23T15:27:42.672Z\"\n}"}],"_postman_id":"25d65a9e-b73e-417a-a4a5-4187a3b2ea0a"},{"name":"Create Letter with Double-Sided Plastic Card from Uploaded PDF","id":"096402da-59ad-4b75-803e-8490c60b25cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"The id or contact object of the receiver. You can either pass a contact object or a contact's id.\nrequired
The id or contact object of the sender. You can either pass a contact object or a contact's id.\nrequired
The template's id to be used for the letter.\nrequired
The location where the address will be placed. Must be either top_first_page or insert_blank_page.\noptional
Indicates if the letter is double sided or not.\noptional\nDefault: false
Indicates whether the letter will be printed in color or not.\noptional
Indicates which page should be perforated. If supplied, the value must be 1 meaning perforate the first page.
optional
Indicates extra services for the letter. See certified and registered mail.\noptional
Indicates the envelope type for the letter. Must be either standard_double_window or flat.\noptional
The id of the return envelope to be used.\noptional
The desired date for the letter to be sent out.
\noptional
See express shipping.
\n"},{"key":"description","value":"Template with attached PDF","type":"text","description":"A description for the letter.
\noptional
Defaults to first_class. See mailing class.\noptional
Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See letter size
\noptional
The PDF to be used for the plastic card.
\nrequired
Size of plastic card
\nrequired
Create a letter order with an HTML template and attach a PDF file before/after the template.
\n","urlObject":{"path":["v1","letters"],"host":["https://api.postgrid.com/print-mail"],"query":[],"variable":[]}},"response":[{"id":"0fce6664-904d-4d71-87ba-d955ca0dbb65","name":"Create Letter with Double-Sided Plastic Card from Uploaded PDF","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"to","value":"contact_8v1mibdKkpK8Si6vz7xBVi","type":"text","description":"The `id` or [contact](#contact) `object` of the receiver. You can either pass a contact `object` or a contact's `id`.\n`required`"},{"key":"from","value":"contact_8v1mibdKkpK8Si6vz7xBVi","type":"text","description":"The `id` or [contact](#contact) `object` of the sender. You can either pass a contact `object` or a contact's `id`.\n`required`"},{"key":"template","value":"template_5n7fprLVnDDsULzhguWBaZ","type":"text","description":"The template's `id` to be used for the letter.\n`required`"},{"key":"addressPlacement","value":"top_first_page","type":"text","description":"The location where the address will be placed. Must be either `top_first_page` or `insert_blank_page`.\n`optional`"},{"key":"doubleSided","value":"true","type":"text","description":"Indicates if the letter is double sided or not.\n`optional`\nDefault: `false`"},{"key":"color","value":"false","type":"text","description":"Indicates whether the letter will be printed in color or not.\n`optional`"},{"key":"perforatedPage","value":"1","type":"text","description":"Indicates which page should be perforated. If supplied, the value must be `1` meaning perforate the first page.\n\n`optional`","disabled":true},{"key":"extraService","value":"certified","type":"text","description":"Indicates extra services for the letter. See [certified and registered mail](#certified-and-registered-mail).\n`optional`"},{"key":"envelopeType","value":"flat","type":"text","description":"Indicates the envelope type for the letter. Must be either `standard_double_window` or `flat`.\n`optional`","disabled":true},{"key":"returnEnvelope","value":"return_envelope_97Tcv1LxhWWLPUvn58CuVJ","type":"text","description":"The `id` of the [return envelope](#return-envelope) to be used.\n`optional`","disabled":true},{"key":"sendDate","value":"2023-02-16T15:40:35.873Z","type":"text","description":"The desired date for the letter to be sent out.\n\n`optional`","disabled":true},{"key":"express","value":"false","type":"text","description":"See [express shipping](#express-shipping)."},{"key":"description","value":"Template with attached PDF","type":"text","description":"A description for the letter.\n\n`optional`"},{"key":"mailingClass","value":"first_class","type":"text","description":"Defaults to `first_class`. See [mailing class](#mailing-class).\n`optional`","disabled":true},{"key":"mergeVariables[language]","value":"english","type":"text"},{"key":"metadata[company]","value":"PostGrid","type":"text"},{"key":"size","value":"us_letter","type":"text","description":"Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See [letter size](#letter-size)\n\n`optional`"},{"key":"plasticCard[doubleSided][pdf]","description":"The PDF to be used for the plastic card.\n\n`required`","type":"file","src":"SWoWDlfuG/2_page_plastic_card_ex.pdf"},{"key":"plasticCard[size]","description":"Size of plastic card\n\n`required`","type":"text","value":"standard"}]},"url":"https://api.postgrid.com/print-mail/v1/letters"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2024 15:28:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1408"},{"key":"Connection","value":"keep-alive"},{"key":"strict-transport-security","value":"max-age=63072000; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"content-security-policy","value":"default-src 'none'"},{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"etag","value":"W/\"580-2BR7CmCvUmRZpqFD+Xz2odQtkfs\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=iMZSwjOFggjizIwv9rukmvzSa46qcJgEBYFFbYal3niP8JjN7H%2BtOY%2FdQHcGZErOQ0DW00lKOF9AZJkSc%2F7uoVLDQ8V4%2FtF6WlB2tgPboMb1O1leiL8%2BL5bdV3Ccm8hjgK43\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8b7c21929abc82a5-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"letter_6Ae34maMXHJtaCYFxBjrYx\",\n \"object\": \"letter\",\n \"live\": false,\n \"addressPlacement\": \"top_first_page\",\n \"attachedPDF\": null,\n \"carrierTracking\": null,\n \"color\": false,\n \"description\": \"Template with attached PDF\",\n \"doubleSided\": true,\n \"envelope\": \"standard\",\n \"envelopeType\": \"standard_double_window\",\n \"express\": false,\n \"extraService\": \"certified\",\n \"from\": {\n \"id\": \"contact_8v1mibdKkpK8Si6vz7xBVi\",\n \"object\": \"contact\",\n \"addressLine1\": \"20 MASS AVE\",\n \"addressLine2\": null,\n \"addressStatus\": \"verified\",\n \"city\": \"CAMBRIDGE\",\n \"country\": \"UNITED STATES\",\n \"countryCode\": \"US\",\n \"firstName\": \"Brian\",\n \"postalOrZip\": \"10013\",\n \"provinceOrState\": \"MA\"\n },\n \"mailingClass\": \"first_class\",\n \"mergeVariables\": {\n \"language\": \"english\"\n },\n \"metadata\": {\n \"company\": \"PostGrid\"\n },\n \"plasticCard\": {\n \"doubleSided\": {\n \"uploadedPDF\": \"https://pg-prod-bucket-1.s3.amazonaws.com/test/pdf_vSf84UiX1eUp4aaQD42oep?AWSAccessKeyId=AKIA5GFUILSULWTWCR64&Expires=1724427793&Signature=%2B4L1S0NnKU7%2BKB5NRVyoW1IIf2w%3D\"\n },\n \"size\": \"standard\"\n },\n \"sendDate\": \"2024-08-23T15:28:13.303Z\",\n \"size\": \"us_letter\",\n \"status\": \"ready\",\n \"template\": \"template_5n7fprLVnDDsULzhguWBaZ\",\n \"to\": {\n \"id\": \"contact_8v1mibdKkpK8Si6vz7xBVi\",\n \"object\": \"contact\",\n \"addressLine1\": \"20 MASS AVE\",\n \"addressLine2\": null,\n \"addressStatus\": \"verified\",\n \"city\": \"CAMBRIDGE\",\n \"country\": \"UNITED STATES\",\n \"countryCode\": \"US\",\n \"firstName\": \"Brian\",\n \"postalOrZip\": \"10013\",\n \"provinceOrState\": \"MA\"\n },\n \"createdAt\": \"2024-08-23T15:28:13.305Z\",\n \"updatedAt\": \"2024-08-23T15:28:13.305Z\"\n}"}],"_postman_id":"096402da-59ad-4b75-803e-8490c60b25cc"},{"name":"Create Letter with Double-Sided Plastic Card from PDF Link","id":"75c4c7b1-1228-414d-82af-0d8ffa9a866f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"The id or contact object of the receiver. You can either pass a contact object or a contact's id.\nrequired
The id or contact object of the sender. You can either pass a contact object or a contact's id.\nrequired
The template's id to be used for the letter.\nrequired
The location where the address will be placed. Must be either top_first_page or insert_blank_page.\noptional
Indicates if the letter is double sided or not.\noptional\nDefault: false
Indicates whether the letter will be printed in color or not.\noptional
Indicates which page should be perforated. If supplied, the value must be 1 meaning perforate the first page.
optional
Indicates extra services for the letter. See certified and registered mail.\noptional
Indicates the envelope type for the letter. Must be either standard_double_window or flat.\noptional
The id of the return envelope to be used.\noptional
The desired date for the letter to be sent out.
\noptional
See express shipping.
\n"},{"key":"description","value":"Template with attached PDF","type":"text","description":"A description for the letter.
\noptional
Defaults to first_class. See mailing class.\noptional
Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See letter size
\noptional
The uploaded PDF to be used for the plastic card.
\nrequired
Size of plastic card
\nrequired
The link to the PDF to be used for the plastic card.
\nrequired
Create a letter order with an HTML template and attach a PDF file before/after the template.
\n","urlObject":{"path":["v1","letters"],"host":["https://api.postgrid.com/print-mail"],"query":[],"variable":[]}},"response":[{"id":"9a37be2b-84d2-4096-b78d-5ccc8a15e427","name":"Create Letter with Double-Sided Plastic Card from PDF Link","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"to","value":"contact_8v1mibdKkpK8Si6vz7xBVi","type":"text","description":"The `id` or [contact](#contact) `object` of the receiver. You can either pass a contact `object` or a contact's `id`.\n`required`"},{"key":"from","value":"contact_8v1mibdKkpK8Si6vz7xBVi","type":"text","description":"The `id` or [contact](#contact) `object` of the sender. You can either pass a contact `object` or a contact's `id`.\n`required`"},{"key":"template","value":"template_5n7fprLVnDDsULzhguWBaZ","type":"text","description":"The template's `id` to be used for the letter.\n`required`"},{"key":"addressPlacement","value":"top_first_page","type":"text","description":"The location where the address will be placed. Must be either `top_first_page` or `insert_blank_page`.\n`optional`"},{"key":"doubleSided","value":"true","type":"text","description":"Indicates if the letter is double sided or not.\n`optional`\nDefault: `false`"},{"key":"color","value":"false","type":"text","description":"Indicates whether the letter will be printed in color or not.\n`optional`"},{"key":"perforatedPage","value":"1","type":"text","description":"Indicates which page should be perforated. If supplied, the value must be `1` meaning perforate the first page.\n\n`optional`","disabled":true},{"key":"extraService","value":"certified","type":"text","description":"Indicates extra services for the letter. See [certified and registered mail](#certified-and-registered-mail).\n`optional`"},{"key":"envelopeType","value":"flat","type":"text","description":"Indicates the envelope type for the letter. Must be either `standard_double_window` or `flat`.\n`optional`","disabled":true},{"key":"returnEnvelope","value":"return_envelope_97Tcv1LxhWWLPUvn58CuVJ","type":"text","description":"The `id` of the [return envelope](#return-envelope) to be used.\n`optional`","disabled":true},{"key":"sendDate","value":"2023-02-16T15:40:35.873Z","type":"text","description":"The desired date for the letter to be sent out.\n\n`optional`","disabled":true},{"key":"express","value":"false","type":"text","description":"See [express shipping](#express-shipping)."},{"key":"description","value":"Template with attached PDF","type":"text","description":"A description for the letter.\n\n`optional`"},{"key":"mailingClass","value":"first_class","type":"text","description":"Defaults to `first_class`. See [mailing class](#mailing-class).\n`optional`","disabled":true},{"key":"mergeVariables[language]","value":"english","type":"text"},{"key":"metadata[company]","value":"PostGrid","type":"text"},{"key":"size","value":"us_letter","type":"text","description":"Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See [letter size](#letter-size)\n\n`optional`"},{"key":"plasticCard[singleSided][pdf]","description":"The uploaded PDF to be used for the plastic card.\n\n`required`","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["jUFcXcLQ3/plastic_card_ex.pdf"],"src":"jUFcXcLQ3/plastic_card_ex.pdf","disabled":true},{"key":"plasticCard[size]","value":"standard","description":"Size of plastic card\n\n`required`","type":"text"},{"key":"plasticCard[doubleSided][pdf]","value":"https://eksandbox.s3.amazonaws.com/files/2_page_plastic_card_ex.pdf","type":"text","description":"The link to the PDF to be used for the plastic card.\n\n`required`"}]},"url":"https://api.postgrid.com/print-mail/v1/letters"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 23 Aug 2024 15:26:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1406"},{"key":"Connection","value":"keep-alive"},{"key":"strict-transport-security","value":"max-age=63072000; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"content-security-policy","value":"default-src 'none'"},{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"etag","value":"W/\"57e-YZlSEDH/gKs13MWnnP1YDybnQjs\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=F8eBYdGiIrWUwi4DWwfDv0vkrcZyuIaMoUj%2FK6qmRVWwgM6re3COIMhI9Zctsku6QIEQ%2BKnJW65MS1RKpB%2BOmTOf3aVOLzveG%2BA279thSK0stfMr36aPWVx1ALw%2BJ9m98p3W\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8b7c1ebcdf7b2090-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"letter_7uuieeMpRwX9fbGjGYSFSw\",\n \"object\": \"letter\",\n \"live\": false,\n \"addressPlacement\": \"top_first_page\",\n \"attachedPDF\": null,\n \"carrierTracking\": null,\n \"color\": false,\n \"description\": \"Template with attached PDF\",\n \"doubleSided\": true,\n \"envelope\": \"standard\",\n \"envelopeType\": \"standard_double_window\",\n \"express\": false,\n \"extraService\": \"certified\",\n \"from\": {\n \"id\": \"contact_8v1mibdKkpK8Si6vz7xBVi\",\n \"object\": \"contact\",\n \"addressLine1\": \"20 MASS AVE\",\n \"addressLine2\": null,\n \"addressStatus\": \"verified\",\n \"city\": \"CAMBRIDGE\",\n \"country\": \"UNITED STATES\",\n \"countryCode\": \"US\",\n \"firstName\": \"Brian\",\n \"postalOrZip\": \"10013\",\n \"provinceOrState\": \"MA\"\n },\n \"mailingClass\": \"first_class\",\n \"mergeVariables\": {\n \"language\": \"english\"\n },\n \"metadata\": {\n \"company\": \"PostGrid\"\n },\n \"plasticCard\": {\n \"doubleSided\": {\n \"uploadedPDF\": \"https://pg-prod-bucket-1.s3.amazonaws.com/test/pdf_vSf84UiX1eUp4aaQD42oep?AWSAccessKeyId=AKIA5GFUILSULWTWCR64&Expires=1724427677&Signature=W%2FrqtB64SRXAG0IQbIVubLxwUy0%3D\"\n },\n \"size\": \"standard\"\n },\n \"sendDate\": \"2024-08-23T15:26:17.416Z\",\n \"size\": \"us_letter\",\n \"status\": \"ready\",\n \"template\": \"template_5n7fprLVnDDsULzhguWBaZ\",\n \"to\": {\n \"id\": \"contact_8v1mibdKkpK8Si6vz7xBVi\",\n \"object\": \"contact\",\n \"addressLine1\": \"20 MASS AVE\",\n \"addressLine2\": null,\n \"addressStatus\": \"verified\",\n \"city\": \"CAMBRIDGE\",\n \"country\": \"UNITED STATES\",\n \"countryCode\": \"US\",\n \"firstName\": \"Brian\",\n \"postalOrZip\": \"10013\",\n \"provinceOrState\": \"MA\"\n },\n \"createdAt\": \"2024-08-23T15:26:17.421Z\",\n \"updatedAt\": \"2024-08-23T15:26:17.421Z\"\n}"}],"_postman_id":"75c4c7b1-1228-414d-82af-0d8ffa9a866f"},{"name":"Create Letter with Single-Sided Plastic Card from Template ID","id":"16793ce8-b3e0-4868-bfd4-2ae606c00cb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
required
The HTML content of the letter.
\nrequired
The location where the address will be placed. Must be either top_first_page or insert_blank_page.
optional
Indicates if the letter is double sided or not.
\noptional\nDefault: false
Indicates whether the letter will be printed in color or not.
\noptional\nDefault: false
Indicates which page is to be perforated. Currently the only valid value is 1 (the first page).
optional
Indicates extra services for the letter. See certified and registered mail.
\noptional
Indicates the envelope type for the letter. Must be either standard_double_window or flat.
optional
The id of the return envelope to be used.
optional
The desired date for the letter to be sent out.
\noptional
A description for the letter.
\noptional
See express shipping.
\n","type":"text"},{"key":"mergeVariables[language]","value":"english","description":"See merge variables.
\noptional
See metadata.
\noptional
Defaults to first_class. See mailing class.
optional
Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See letter size
\noptional
The template's id to be used for the plastic card.
required
Size of plastic card
\nrequired
Create a letter order using HTML.
\n","urlObject":{"path":["v1","letters"],"host":["https://api.postgrid.com/print-mail"],"query":[],"variable":[]}},"response":[{"id":"409b4bdb-dd8f-49cd-90d6-0b5ebf34b1c5","name":"Create Letter with Single-Sided Plastic Card from Template ID","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"to","value":"contact_fFh9tg3SgD8LRXxatVAWt2","description":"The `id` or [contact](#contact) `object` of the receiver. You can either pass a contact `object` or a contact's `id`.\n\n`required`","type":"text"},{"key":"from","value":"contact_fFh9tg3SgD8LRXxatVAWt2","description":"The `id` or [contact](#contact) `object` of the sender. You can either pass a contact `object` or a contact's `id`.\n\n`required`","type":"text"},{"key":"html","value":"Hello, {{to.firstName}}!","type":"text","description":"The HTML content of the letter.\n\n`required`"},{"key":"addressPlacement","value":"top_first_page","description":"The location where the address will be placed. Must be either `top_first_page` or `insert_blank_page`.\n\n`optional`","type":"text"},{"key":"doubleSided","value":"true","type":"text","description":"Indicates if the letter is double sided or not.\n\n`optional`\nDefault: `false`"},{"key":"color","value":"false","type":"text","description":"Indicates whether the letter will be printed in color or not.\n\n`optional`\nDefault: `false`"},{"key":"perforatedPage","value":"1","description":"Indicates which page is to be perforated. Currently the only valid value is `1` (the first page).\n\n`optional`","type":"text"},{"key":"extraService","value":"certified","description":"Indicates extra services for the letter. See [certified and registered mail](#certified-and-registered-mail).\n\n`optional`","type":"text"},{"key":"envelopeType","value":"flat","description":"Indicates the envelope type for the letter. Must be either `standard_double_window` or `flat`.\n\n`optional`","type":"text"},{"key":"returnEnvelope","value":"return_envelope_97Tcv1LxhWWLPUvn58CuVJ","description":"The `id` of the [return envelope](#return-envelope) to be used.\n\n`optional`","type":"text","disabled":true},{"key":"sendDate","value":"2023-02-16T15:40:35.873Z","description":"The desired date for the letter to be sent out.\n\n`optional`","type":"text","disabled":true},{"key":"description","value":"My HTML letter","description":"A description for the letter.\n\n`optional`","type":"text"},{"key":"express","value":"false","description":"See [express shipping](#express-shipping).","type":"text"},{"key":"mergeVariables[language]","value":"english","description":"See [merge variables](#merge-variables).\n\n`optional`","type":"text"},{"key":"metadata[company]","value":"PostGrid","description":"See [metadata](#metadata).\n\n`optional`","type":"text"},{"key":"mailingClass","value":"first_class","description":"Defaults to `first_class`. See [mailing class](#mailing-class).\n\n`optional`","type":"text"},{"key":"size","value":"us_letter","description":"Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See [letter size](#letter-size)\n\n`optional`","type":"text"},{"key":"plasticCard[singleSided][template]","value":"template_nYuXaSsEKGKcCAT9ZM4Cz6","description":"The template's `id` to be used for the plastic card.\n\n`required`","type":"text"},{"key":"plasticCard[size]","value":"standard","description":"Size of plastic card\n\n`required`","type":"text"}]},"url":"https://api.postgrid.com/print-mail/v1/letters"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 Aug 2024 22:41:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1139"},{"key":"Connection","value":"keep-alive"},{"key":"strict-transport-security","value":"max-age=63072000; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"content-security-policy","value":"default-src 'none'"},{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"etag","value":"W/\"473-eQ+d6HvgX01Mzg32O5ceRkyWWWw\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=bAZbXT%2FLvzdFX7AsVleQcg1A%2FfxsPSIM81B8DvAHjb04hzjJN9LaKbW2s%2Bh2IJeaHQQhQF1POhrxeTOGR%2FRxhSm9RoT3Xt7CqtnCjxQQP%2B15TioYp6S44qS%2F%2FMLzMFSw8IgA\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8b5da72b09f381be-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"letter_cogptyy9GhMC8jHviJ4PVa\",\n \"object\": \"letter\",\n \"live\": false,\n \"addressPlacement\": \"top_first_page\",\n \"attachedPDF\": null,\n \"carrierTracking\": null,\n \"color\": false,\n \"description\": \"My HTML letter\",\n \"doubleSided\": true,\n \"envelope\": \"standard\",\n \"envelopeType\": \"flat\",\n \"express\": false,\n \"extraService\": \"certified\",\n \"from\": {\n \"id\": \"contact_fFh9tg3SgD8LRXxatVAWt2\",\n \"object\": \"contact\",\n \"addressLine1\": \"145 MULBERRY ST\",\n \"addressStatus\": \"verified\",\n \"city\": \"NEW YORK\",\n \"country\": \"UNITED STATES\",\n \"countryCode\": \"US\",\n \"firstName\": \"Alexander Great\",\n \"postalOrZip\": \"10013\",\n \"provinceOrState\": \"NY\"\n },\n \"html\": \"Hello, {{to.firstName}}!\",\n \"mailingClass\": \"first_class\",\n \"mergeVariables\": {\n \"language\": \"english\"\n },\n \"metadata\": {\n \"company\": \"PostGrid\"\n },\n \"plasticCard\": {\n \"singleSided\": {\n \"template\": \"template_nYuXaSsEKGKcCAT9ZM4Cz6\"\n },\n \"size\": \"standard\"\n },\n \"perforatedPage\": 1,\n \"sendDate\": \"2024-08-19T22:41:46.753Z\",\n \"size\": \"us_letter\",\n \"status\": \"ready\",\n \"to\": {\n \"id\": \"contact_fFh9tg3SgD8LRXxatVAWt2\",\n \"object\": \"contact\",\n \"addressLine1\": \"145 MULBERRY ST\",\n \"addressStatus\": \"verified\",\n \"city\": \"NEW YORK\",\n \"country\": \"UNITED STATES\",\n \"countryCode\": \"US\",\n \"firstName\": \"Alexander Great\",\n \"postalOrZip\": \"10013\",\n \"provinceOrState\": \"NY\"\n },\n \"createdAt\": \"2024-08-19T22:41:46.755Z\",\n \"updatedAt\": \"2024-08-19T22:41:46.755Z\"\n}"}],"_postman_id":"16793ce8-b3e0-4868-bfd4-2ae606c00cb5"},{"name":"Create Letter with Double-Sided Plastic Card from Template ID","id":"90f68824-03af-4a8c-83bf-48f77b83f6c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
required
The HTML content of the letter.
\nrequired
The location where the address will be placed. Must be either top_first_page or insert_blank_page.
optional
Indicates if the letter is double sided or not.
\noptional\nDefault: false
Indicates whether the letter will be printed in color or not.
\noptional\nDefault: false
Indicates which page is to be perforated. Currently the only valid value is 1 (the first page).
optional
Indicates extra services for the letter. See certified and registered mail.
\noptional
Indicates the envelope type for the letter. Must be either standard_double_window or flat.
optional
The id of the return envelope to be used.
optional
The desired date for the letter to be sent out.
\noptional
A description for the letter.
\noptional
See express shipping.
\n","type":"text"},{"key":"mergeVariables[language]","value":"english","description":"See merge variables.
\noptional
See metadata.
\noptional
Defaults to first_class. See mailing class.
optional
Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See letter size
\noptional
The template's id to be used for the front of the plastic card.
required
The template's id to be used for the back of the plastic card.
required
Size of plastic card
\nrequired
Create a letter order using HTML.
\n","urlObject":{"path":["v1","letters"],"host":["https://api.postgrid.com/print-mail"],"query":[],"variable":[]}},"response":[{"id":"5ba6e628-39ff-4ed0-a769-56aae2a3cb49","name":"Create Letter with Double-Sided Plastic Card from Template ID","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"to","value":"contact_fFh9tg3SgD8LRXxatVAWt2","description":"The `id` or [contact](#contact) `object` of the receiver. You can either pass a contact `object` or a contact's `id`.\n\n`required`","type":"text"},{"key":"from","value":"contact_fFh9tg3SgD8LRXxatVAWt2","description":"The `id` or [contact](#contact) `object` of the sender. You can either pass a contact `object` or a contact's `id`.\n\n`required`","type":"text"},{"key":"html","value":"Hello, {{to.firstName}}!","type":"text","description":"The HTML content of the letter.\n\n`required`"},{"key":"addressPlacement","value":"top_first_page","description":"The location where the address will be placed. Must be either `top_first_page` or `insert_blank_page`.\n\n`optional`","type":"text"},{"key":"doubleSided","value":"true","type":"text","description":"Indicates if the letter is double sided or not.\n\n`optional`\nDefault: `false`"},{"key":"color","value":"false","type":"text","description":"Indicates whether the letter will be printed in color or not.\n\n`optional`\nDefault: `false`"},{"key":"perforatedPage","value":"1","description":"Indicates which page is to be perforated. Currently the only valid value is `1` (the first page).\n\n`optional`","type":"text"},{"key":"extraService","value":"certified","description":"Indicates extra services for the letter. See [certified and registered mail](#certified-and-registered-mail).\n\n`optional`","type":"text"},{"key":"envelopeType","value":"flat","description":"Indicates the envelope type for the letter. Must be either `standard_double_window` or `flat`.\n\n`optional`","type":"text"},{"key":"returnEnvelope","value":"return_envelope_97Tcv1LxhWWLPUvn58CuVJ","description":"The `id` of the [return envelope](#return-envelope) to be used.\n\n`optional`","type":"text","disabled":true},{"key":"sendDate","value":"2023-02-16T15:40:35.873Z","description":"The desired date for the letter to be sent out.\n\n`optional`","type":"text","disabled":true},{"key":"description","value":"My HTML letter","description":"A description for the letter.\n\n`optional`","type":"text"},{"key":"express","value":"false","description":"See [express shipping](#express-shipping).","type":"text"},{"key":"mergeVariables[language]","value":"english","description":"See [merge variables](#merge-variables).\n\n`optional`","type":"text"},{"key":"metadata[company]","value":"PostGrid","description":"See [metadata](#metadata).\n\n`optional`","type":"text"},{"key":"mailingClass","value":"first_class","description":"Defaults to `first_class`. See [mailing class](#mailing-class).\n\n`optional`","type":"text"},{"key":"size","value":"us_letter","description":"Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See [letter size](#letter-size)\n\n`optional`","type":"text"},{"key":"plasticCard[doubleSided][frontTemplate]","value":"template_nYuXaSsEKGKcCAT9ZM4Cz6","description":"The template's `id` to be used for the front of the plastic card.\n\n`required`","type":"text"},{"key":"plasticCard[doubleSided][backTemplate]","value":"template_nYuXaSsEKGKcCAT9ZM4Cz6","description":"The template's `id` to be used for the back of the plastic card.\n\n`required`","type":"text"},{"key":"plasticCard[size]","value":"standard","description":"Size of plastic card\n\n`required`","type":"text"}]},"url":"https://api.postgrid.com/print-mail/v1/letters"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 19 Aug 2024 22:43:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1139"},{"key":"Connection","value":"keep-alive"},{"key":"strict-transport-security","value":"max-age=63072000; preload"},{"key":"x-content-type-options","value":"nosniff"},{"key":"content-security-policy","value":"default-src 'none'"},{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"etag","value":"W/\"473-4kQcvdReqI65EoJX3EMUv7v7cfg\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=eK3DVGyZoJ4i%2BlN6bZbT3xjY7uvX%2B35NWkgJm5%2BNqnrxyZ9I3wk8iDC9wIra9dhkp%2FQR5%2FLBzD4UCMbRB7r0rCnspYE7xzdg6sUtbeaxlb3uGXMGnQiI8C4CG9gMnFH4lvMV\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8b5da951fd978236-IAD"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"letter_gBgGWPo35AmwYztJ84AeRW\",\n \"object\": \"letter\",\n \"live\": false,\n \"addressPlacement\": \"top_first_page\",\n \"attachedPDF\": null,\n \"carrierTracking\": null,\n \"color\": false,\n \"description\": \"My HTML letter\",\n \"doubleSided\": true,\n \"envelope\": \"standard\",\n \"envelopeType\": \"flat\",\n \"express\": false,\n \"extraService\": \"certified\",\n \"from\": {\n \"id\": \"contact_fFh9tg3SgD8LRXxatVAWt2\",\n \"object\": \"contact\",\n \"addressLine1\": \"145 MULBERRY ST\",\n \"addressStatus\": \"verified\",\n \"city\": \"NEW YORK\",\n \"country\": \"UNITED STATES\",\n \"countryCode\": \"US\",\n \"firstName\": \"Alexander Great\",\n \"postalOrZip\": \"10013\",\n \"provinceOrState\": \"NY\"\n },\n \"html\": \"Hello, {{to.firstName}}!\",\n \"mailingClass\": \"first_class\",\n \"mergeVariables\": {\n \"language\": \"english\"\n },\n \"metadata\": {\n \"company\": \"PostGrid\"\n },\n \"plasticCard\": {\n \"doubleSided\": {\n \"frontTemplate\": \"template_nYuXaSsEKGKcCAT9ZM4Cz6\",\n \"backTemplate\": \"template_nYuXaSsEKGKcCAT9ZM4Cz6\"\n },\n \"size\": \"standard\"\n },\n \"perforatedPage\": 1,\n \"sendDate\": \"2024-08-19T22:43:14.893Z\",\n \"size\": \"us_letter\",\n \"status\": \"ready\",\n \"to\": {\n \"id\": \"contact_fFh9tg3SgD8LRXxatVAWt2\",\n \"object\": \"contact\",\n \"addressLine1\": \"145 MULBERRY ST\",\n \"addressStatus\": \"verified\",\n \"city\": \"NEW YORK\",\n \"country\": \"UNITED STATES\",\n \"countryCode\": \"US\",\n \"firstName\": \"Alexander Great\",\n \"postalOrZip\": \"10013\",\n \"provinceOrState\": \"NY\"\n },\n \"createdAt\": \"2024-08-19T22:43:14.895Z\",\n \"updatedAt\": \"2024-08-19T22:43:14.895Z\"\n}"}],"_postman_id":"90f68824-03af-4a8c-83bf-48f77b83f6c1"},{"name":"Create Letter with Single-Sided Plastic Card from HTML","id":"b8b66d1b-c59a-448a-8ea3-7364c8451c2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
required
The HTML content of the letter.
\nrequired
The location where the address will be placed. Must be either top_first_page or insert_blank_page.
optional
Indicates if the letter is double sided or not.
\noptional\nDefault: false
Indicates whether the letter will be printed in color or not.
\noptional\nDefault: false
Indicates which page is to be perforated. Currently the only valid value is 1 (the first page).
optional
Indicates extra services for the letter. See certified and registered mail.
\noptional
Indicates the envelope type for the letter. Must be either standard_double_window or flat.
optional
The id of the return envelope to be used.
optional
The desired date for the letter to be sent out.
\noptional
A description for the letter.
\noptional
See express shipping.
\n","type":"text"},{"key":"mergeVariables[language]","value":"english","description":"See merge variables.
\noptional
See metadata.
\noptional
Defaults to first_class. See mailing class.
optional
Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See letter size
\noptional
The HTML content of the plastic card.
\nrequired
Size of plastic card
\nrequired
Create a letter order using HTML.
\n","urlObject":{"path":["v1","letters"],"host":["https://api.postgrid.com/print-mail"],"query":[],"variable":[]}},"response":[{"id":"43d13741-19c2-473e-8c0f-1e2af5fa9bbd","name":"Create Letter with Single-Sided Plastic Card from HTML","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"to","value":"contact_fFh9tg3SgD8LRXxatVAWt2","description":"The `id` or [contact](#contact) `object` of the receiver. You can either pass a contact `object` or a contact's `id`.\n\n`required`","type":"text"},{"key":"from","value":"contact_fFh9tg3SgD8LRXxatVAWt2","description":"The `id` or [contact](#contact) `object` of the sender. You can either pass a contact `object` or a contact's `id`.\n\n`required`","type":"text"},{"key":"html","value":"Hello, {{to.firstName}}!","type":"text","description":"The HTML content of the letter.\n\n`required`"},{"key":"addressPlacement","value":"top_first_page","description":"The location where the address will be placed. Must be either `top_first_page` or `insert_blank_page`.\n\n`optional`","type":"text"},{"key":"doubleSided","value":"true","type":"text","description":"Indicates if the letter is double sided or not.\n\n`optional`\nDefault: `false`"},{"key":"color","value":"false","type":"text","description":"Indicates whether the letter will be printed in color or not.\n\n`optional`\nDefault: `false`"},{"key":"perforatedPage","value":"1","description":"Indicates which page is to be perforated. Currently the only valid value is `1` (the first page).\n\n`optional`","type":"text"},{"key":"extraService","value":"certified","description":"Indicates extra services for the letter. See [certified and registered mail](#certified-and-registered-mail).\n\n`optional`","type":"text"},{"key":"envelopeType","value":"flat","description":"Indicates the envelope type for the letter. Must be either `standard_double_window` or `flat`.\n\n`optional`","type":"text"},{"key":"returnEnvelope","value":"return_envelope_97Tcv1LxhWWLPUvn58CuVJ","description":"The `id` of the [return envelope](#return-envelope) to be used.\n\n`optional`","type":"text","disabled":true},{"key":"sendDate","value":"2023-02-16T15:40:35.873Z","description":"The desired date for the letter to be sent out.\n\n`optional`","type":"text","disabled":true},{"key":"description","value":"My HTML letter","description":"A description for the letter.\n\n`optional`","type":"text"},{"key":"express","value":"false","description":"See [express shipping](#express-shipping).","type":"text"},{"key":"mergeVariables[language]","value":"english","description":"See [merge variables](#merge-variables).\n\n`optional`","type":"text"},{"key":"metadata[company]","value":"PostGrid","description":"See [metadata](#metadata).\n\n`optional`","type":"text"},{"key":"mailingClass","value":"first_class","description":"Defaults to `first_class`. See [mailing class](#mailing-class).\n\n`optional`","type":"text"},{"key":"size","value":"us_letter","description":"Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See [letter size](#letter-size)\n\n`optional`","type":"text"},{"key":"plasticCard[singleSided][html]","value":"The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
required
The HTML content of the letter.
\nrequired
The location where the address will be placed. Must be either top_first_page or insert_blank_page.
optional
Indicates if the letter is double sided or not.
\noptional\nDefault: false
Indicates whether the letter will be printed in color or not.
\noptional\nDefault: false
Indicates which page is to be perforated. Currently the only valid value is 1 (the first page).
optional
Indicates extra services for the letter. See certified and registered mail.
\noptional
Indicates the envelope type for the letter. Must be either standard_double_window or flat.
optional
The id of the return envelope to be used.
optional
The desired date for the letter to be sent out.
\noptional
A description for the letter.
\noptional
See express shipping.
\n","type":"text"},{"key":"mergeVariables[language]","value":"english","description":"See merge variables.
\noptional
See metadata.
\noptional
Defaults to first_class. See mailing class.
optional
Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See letter size
\noptional
The HTML content of the front of the plastic card.
\n","type":"text"},{"key":"plasticCard[doubleSided][backHTML]","value":"The HTML content of the back of the plastic card.
\n","type":"text"},{"key":"plasticCard[size]","value":"standard","description":"Size of plastic card
\n","type":"text"}]},"url":"https://api.postgrid.com/print-mail/v1/letters","description":"Create a letter order using HTML.
\n","urlObject":{"path":["v1","letters"],"host":["https://api.postgrid.com/print-mail"],"query":[],"variable":[]}},"response":[{"id":"010c74e7-bd69-4268-89a1-8da244b85cec","name":"Create Letter with Double-Sided Plastic Card from HTML","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"to","value":"contact_fFh9tg3SgD8LRXxatVAWt2","description":"The `id` or [contact](#contact) `object` of the receiver. You can either pass a contact `object` or a contact's `id`.\n\n`required`","type":"text"},{"key":"from","value":"contact_fFh9tg3SgD8LRXxatVAWt2","description":"The `id` or [contact](#contact) `object` of the sender. You can either pass a contact `object` or a contact's `id`.\n\n`required`","type":"text"},{"key":"html","value":"Hello, {{to.firstName}}!","type":"text","description":"The HTML content of the letter.\n\n`required`"},{"key":"addressPlacement","value":"top_first_page","description":"The location where the address will be placed. Must be either `top_first_page` or `insert_blank_page`.\n\n`optional`","type":"text"},{"key":"doubleSided","value":"true","type":"text","description":"Indicates if the letter is double sided or not.\n\n`optional`\nDefault: `false`"},{"key":"color","value":"false","type":"text","description":"Indicates whether the letter will be printed in color or not.\n\n`optional`\nDefault: `false`"},{"key":"perforatedPage","value":"1","description":"Indicates which page is to be perforated. Currently the only valid value is `1` (the first page).\n\n`optional`","type":"text"},{"key":"extraService","value":"certified","description":"Indicates extra services for the letter. See [certified and registered mail](#certified-and-registered-mail).\n\n`optional`","type":"text"},{"key":"envelopeType","value":"flat","description":"Indicates the envelope type for the letter. Must be either `standard_double_window` or `flat`.\n\n`optional`","type":"text"},{"key":"returnEnvelope","value":"return_envelope_97Tcv1LxhWWLPUvn58CuVJ","description":"The `id` of the [return envelope](#return-envelope) to be used.\n\n`optional`","type":"text","disabled":true},{"key":"sendDate","value":"2023-02-16T15:40:35.873Z","description":"The desired date for the letter to be sent out.\n\n`optional`","type":"text","disabled":true},{"key":"description","value":"My HTML letter","description":"A description for the letter.\n\n`optional`","type":"text"},{"key":"express","value":"false","description":"See [express shipping](#express-shipping).","type":"text"},{"key":"mergeVariables[language]","value":"english","description":"See [merge variables](#merge-variables).\n\n`optional`","type":"text"},{"key":"metadata[company]","value":"PostGrid","description":"See [metadata](#metadata).\n\n`optional`","type":"text"},{"key":"mailingClass","value":"first_class","description":"Defaults to `first_class`. See [mailing class](#mailing-class).\n\n`optional`","type":"text"},{"key":"size","value":"us_letter","description":"Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. See [letter size](#letter-size)\n\n`optional`","type":"text"},{"key":"plasticCard[doubleSided][frontHTML]","value":"The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
optional
The HTML content for the front of the postcard.
\nrequired
The HTML content for the back of the postcard.
\nrequired
A string denoting the size of the postcard. Must be one of either 6x4, 9x6 or 11x6.
required
The desired date for the letter to be sent out.
\noptional
See express shipping.
\n","type":"text"},{"key":"description","value":"My HTML postcard","description":"A description for the postcard.
\noptional
Defaults to first_class. See mailing class.
optional
See merge variables.
\noptional
See metadata.
\noptional
Indicates the postcard size for the postcard being created.\noptional
Creates a new postcard order with HTML content.
\n","auth":{"type":"apikey","apikey":{"key":"The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
optional
The id of the template to be used for the front of the postcard.
required
The id of the template to be used for the back of the postcard.
required
A string denoting the size of the postcard. Must be one of either 6x4, 9x6 or 11x6.
required
The desired date for the letter to be sent out.
\noptional
See express shipping.
\n","type":"text"},{"key":"description","value":"My template postcard!","description":"A description for the postcard.
\noptional
Defaults to first_class. See mailing class.
optional
See merge variables.
\noptional
See metadata.
\noptional
Indicates the postcard size for the postcard being created.\noptional
Creates a new postcard from a pre-existing template.
\n","auth":{"type":"apikey","apikey":{"key":"See expansions.
\noptional
See expansions.
\noptional
The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
optional
A PDF to be uploaded and used for the postcard.
\nrequried
A string denoting the size of the postcard. Must be one of either 6x4, 9x6 or 11x6.
required
The desired date for the letter to be sent out.
\noptional
See express shipping.
\n","type":"text"},{"key":"description","value":"9x6 reduced Samples","description":"A description for the postcard.
\noptional
Defaults to first_class. See mailing class.
optional
See merge variables.
\noptional
See metadata.
\noptional
Indicates the postcard size for the postcard being created.\noptional
Creates a new postcard from an uploaded PDF.
\n","urlObject":{"path":["v1","postcards"],"host":["https://api.postgrid.com/print-mail"],"query":[],"variable":[]}},"response":[{"id":"a2814bef-339e-45b5-8e43-5d3a3ee698aa","name":"Create Postcard with PDF","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"to[firstName]","value":"Kevin","type":"text"},{"key":"to[addressLine1]","value":"20-20 bay st","type":"text"},{"key":"size","value":"9x6","type":"text"},{"key":"pdf","type":"file","src":"/home/apaar/Downloads/Postcard_Test_9x6.pdf"},{"key":"to[city]","value":"Toronto","type":"text"}]},"url":"https://api.postgrid.com/print-mail/v1/postcards"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"663"},{"key":"ETag","value":"W/\"297-MHOjwd9Nffw61+Dy1gLNzhefJoY\""},{"key":"Date","value":"Wed, 23 Dec 2020 07:10:08 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"postcard_rCbN9Tp1GndociRVmbXcfn\",\n \"object\": \"postcard\",\n \"live\": true,\n \"sendDate\": \"2020-12-23T07:10:08.413Z\",\n \"size\": \"9x6\",\n \"status\": \"ready\",\n \"to\": {\n \"id\": \"contact_6fMMFdvk7YSSKVgaKyJaQS\",\n \"object\": \"contact\",\n \"addressLine1\": \"20-20 BAY ST\",\n \"addressLine2\": \"\",\n \"addressStatus\": \"corrected\",\n \"city\": \"TORONTO\",\n \"country\": \"CANADA\",\n \"countryCode\": \"CA\",\n \"firstName\": \"Kevin\",\n \"postalOrZip\": \"M5J 2N8\",\n \"provinceOrState\": \"ON\"\n },\n \"uploadedPDF\": \"https://pg-prod-bucket-1.s3.amazonaws.com/live/pdf_bsdhXXsrpPFtmnWsbkPBwp?AWSAccessKeyId=AKIA5GFUILSUDYW4YKAG&Expires=1608708308&Signature=sgqfUr4yMxa1Th%2FDD4%2B7IiQRiZo%3D\",\n \"createdAt\": \"2020-12-23T07:10:08.442Z\",\n \"updatedAt\": \"2020-12-23T07:10:08.442Z\"\n}"}],"_postman_id":"e50e5e43-a8ad-4a25-9cf1-bff90c8675d4"},{"name":"Create Postcard with PDF Link","id":"0ba4240b-9764-4ffc-8d48-6f422fba6f3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"to","value":"contact_pxd7wnnD1xY6H6etKNvjb4","description":"The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
optional
A publicly accessible URL to a PDF to be used for the postcard.
\nrequired
A string denoting the size of the postcard. Must be one of either 6x4, 9x6 or 11x6.
required
The desired date for the letter to be sent out.
\noptional
See express shipping.
\n","type":"text"},{"key":"description","value":"My URL PDF postcard","description":"A description for the postcard.
\noptional
Defaults to first_class. See mailing class.
optional
See merge variables.
\noptional
See metadata.
\noptional
Creates a new postcard from a publicly accessible PDF link.
\n","auth":{"type":"apikey","apikey":{"key":"Gets a specific postcard based on the passed id. This should be a unique identifying string starting with postcard_.
Must be either frontTemplate or backTempalte. See expansions. If the postcard was created with a template, it will return the templates nested information.
optional
Must be either frontTemplate or backTempalte. See expansions. If the postcard was created with a template, it will return the templates nested information.\noptional
Gets all postcards for the user.
\n","auth":{"type":"apikey","apikey":{"key":"Used for traversing pages. See lists and pagination.
\noptional
Limits the number of resources returned. See lists and pagination.
\noptional
Searches the data for the given input. See search.
\noptional
Cancels a postcard by the specified id. This should be a unique identifying string starting with postcard_.
A note for the cancellation of the postcard.\nrequired
Cancels the specified postcard by id with a note describing the reason for cancellation. The id should be a unique identifying string starting with postcard_. The note should be a string.
The id of the postcard to be deleted.\nrequired
Progress the desired test postcard by id to the next status. This can be used to test webhooks. The id should be a unique identifying string that starts with postcard_.
Note: that this will fail with an invalid_progression_error if the status is one of completed or cancelled.
The id of the postcard you want to progress.
required
Create and manage postcard mailings.
\nThe id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
required
The HTML content for the inside of the self mailer.
\nrequired
The HTML content for the outside of the self mailer.
\nrequired
A string denoting the size of the self mailer. Must be 8.5x11_bifold or 8.5x11_trifold.
required
The desired date for the self mailer to be sent out.
\noptional
See express shipping.
\n","type":"text"},{"key":"description","value":"My HTML self mailer","description":"A description for the self mailer.
\noptional
Defaults to first_class. See mailing class.
optional
See merge variables.
\noptional
See metadata.
\noptional
Creates a new self mailer order with HTML content.
\n","auth":{"type":"apikey","apikey":{"key":"The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
required
The id of the template to be used for the inside of the self mailer.
required
The id of the template to be used for the outside of the self mailer.
required
A string denoting the size of the self mailer. Must be 8.5x11_bifold or 8.5x11_trifold.
required
The desired date for the letter to be sent out.
\noptional
See express shipping.
\n","type":"text"},{"key":"description","value":"My template self mailer!","description":"A description for the postcard.
\noptional
Defaults to first_class. See mailing class.
optional
See merge variables.
\noptional
See metadata.
\noptional
Creates a new self mailer from a pre-existing template.
\n","auth":{"type":"apikey","apikey":{"key":"See expansions.
\noptional
See expansions.
\noptional
The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
required
A PDF to be uploaded and used for the self mailer.
\nrequried
A string denoting the size of the self mailer. Must be 8.5x11_bifold or 8.5x11_trifold.
required
The desired date for the self mailer to be sent out.
\noptional
See express shipping.
\n","type":"text"},{"key":"description","value":"My uploaded PDF self mailer","description":"A description for the self mailer.
\noptional
Defaults to first_class. See mailing class.
optional
See merge variables.
\noptional
See metadata.
\noptional
Creates a new self mailer from an uploaded PDF.
\n","auth":{"type":"apikey","apikey":{"key":"The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
required
A publicly accessible URL to a PDF to be used for the self mailer.
\nrequired
A string denoting the size of the self mailer. Must be 8.5x11_bifold or 8.5x11_trifold.
required
The desired date for the self mailer to be sent out.
\noptional
See express shipping.
\n","type":"text"},{"key":"description","value":"My URL PDF self mailer","description":"A description for the self mailer.
\noptional
Defaults to first_class. See mailing class.
optional
See merge variables.
\noptional
See metadata.
\noptional
Creates a new self mailer from a publicly accessible PDF link.
\n","auth":{"type":"apikey","apikey":{"key":"Gets a specific self mailer based on the passed id. This should be a unique identifying string starting with self_mailer_.
Must be either insideTemplate or outsideTemplate. See expansions. If the self mailer was created with a template, it will return the templates nested information.
optional
Must be either insideTemplate or outsideTemplate. See expansions. If the self mailer was created with a template, it will return the templates nested information.
optional
Gets all self mailers for the user.
\n","auth":{"type":"apikey","apikey":{"key":"Used for traversing pages. See lists and pagination.
\noptional
Limits the number of resources returned. See lists and pagination.
\noptional
Searches the data for the given input. See search.
\noptional
Cancels a self mailer by the specified id. This should be a unique identifying string starting with self_mailer_.
Progress the desired test self mailer by id to the next status. This can be used to test webhooks. The id should be a unique identifying string that starts with self_mailer_.
Note: that this will fail with an invalid_progression_error if the status is one of completed or cancelled.
The id of the postcard you want to progress.
required
Create and manage self mailers.
\nThe name of the bank.
\nrequired
The account number, only used when creating the account.
\nrequired
Transit number for cheques associated with this account.
\nrequired
Also referred to as the Financial Institution Number.
required
The corresponding country code for the bank. Must be either CA or US.
required
An image containing a signature.
\nrequired
First line of the bank's address.
\noptional
Second line of the bank's address.
\noptional
A description for the bank account
\noptional
See metadata.
\noptional
Creates a Canadian bank account with all the information necessary to produce a cheque. Note that the body of this request is provided as multipart/form-data. This is because we must upload a signature image with the request.
The name of the bank.
\nrequired
The account number, only used when creating the account.
\nrequired
Transit number for cheques associated with this account.
\nrequired
Also referred to as the Financial Institution Number.
required
Designation number for cheques assosicated with this account.
\n","type":"text","uuid":"4fb46ebf-ee53-4618-9bf0-1a2d67fb027c"},{"key":"bankCountryCode","value":"CA","type":"text","description":"The corresponding country code for the bank. Must be either CA or US.
required
An image containing a signature.
\nrequired
First line of the bank's address.
\noptional
Second line of the bank's address.
\noptional
A description for the bank account
\noptional
See metadata.
\noptional
Creates a Canadian bank account with all the information necessary to produce a cheque. Note that the body of this request is provided as multipart/form-data. This is because we must upload a signature image with the request.
The name of the bank.
\nrequired
The account number, only used when creating the account.
\nrequired
Transit number for cheques associated with this account.
\nrequired
Also referred to as the Financial Institution Number.
required
The corresponding country code for the bank. Must be either CA or US.
required
A publically accessible URL or Base64 encoded data URL of the signature image.
\nrequired
First line of the bank's address.
\noptional
Second line of the bank's address.
\noptional
A description for the bank account
\noptional
See metadata.
\noptional
Creates a Canadian bank account with all the information necessary to produce a cheque. Note that the body of this request is provided as multipart/form-data. This is because we must upload a signature image with the request.
The name of the bank.
\nrequired
The account number, only used when creating the account.
\nrequired
Transit number for cheques associated with this account.
\nrequired
Also referred to as the Financial Institution Number.
required
The corresponding country code for the bank. Must be either CA or US.
required
A string which will be used to create a signature for documents.
\nrequired
First line of the bank's address.
\noptional
Second line of the bank's address.
\noptional
A description for the bank account
\noptional
See metadata.
\noptional
Creates a Canadian bank account with all the information necessary to produce a cheque. This request supplies a signatureText value which is used to create a default signature.
Signature Text Note: the reasonable character limit to enter for the signatureText is 6 capital letters OR 20 lowercase letters, anything exceeding that will likely overflow onto a new line. If you need to use a large signature, it would be best to insert an image instead (See this endpoint)
\n","auth":{"type":"apikey","apikey":{"key":"The name of the bank.
\nrequired
The account number, only used when creating the account.
\nrequired
The bank account's routing number.
\nrequired
The corresponding country code for the bank. Must be either CA or US.
required
An image containing a signature.
\nrequired
First line of the bank's address.
\noptional
Second line of the bank's address.
\noptional
A description for the bank account
\noptional
See metadata.
\noptional
Creates an American bank account with all the information necessary to produce a cheque. Note that the body of this request is provided as multipart/form-data. This is because we must upload a signature image with the request.
The name of the bank.
\nrequired
The account number, only used when creating the account.
\nrequired
The bank account's routing number.
\nrequired
The corresponding country code for the bank. Must be either CA or US.
required
A publically accessible URL or Base64 encoded data URL of the signature image.
\nrequired
First line of the bank's address.
\noptional
Second line of the bank's address.
\noptional
A description for the bank account
\noptional
See metadata.
\noptional
Creates an American bank account with all the information necessary to produce a cheque. Note that the body of this request is provided as multipart/form-data. This is because we must upload a signature image with the request.
The name of the bank.
\nrequired
The account number, only used when creating the account.
\nrequired
The bank account's routing number.
\nrequired
The corresponding country code for the bank. Must be either CA or US.
required
A string which will be used to create a signature for documents.
\nrequired
First line of the bank's address.
\noptional
Second line of the bank's address.
\noptional
A description for the bank account
\noptional
See metadata.
\noptional
Creates an American bank account with all the information necessary to produce a cheque. This request supplies a signatureText value which is used to create a default signature.
Signature Text Note: the reasonable character limit to enter for the signatureText is 6 capital letters OR 20 lowercase letters, anything exceeding that will likely overflow onto a new line. If you need to use a large signature, it would be best to insert an image instead (See this endpoint)
\n","auth":{"type":"apikey","apikey":{"key":"Retrieve a previously created bank account by id. This should be a unique identifying string starting with bank_.
Note: that we do not return the complete account number or the signature image for security reasons.
\n","auth":{"type":"apikey","apikey":{"key":"Retrieves all bank accounts and their information for the current user.
\nNote: that we do not return the complete account number or the signature image for security reasons.
\n","auth":{"type":"apikey","apikey":{"key":"Used for traversing pages. See lists and pagination.
\noptional
Limits the number of resources returned. See lists and pagination.
\noptional
Searches the data for the given input. See search.
\noptional
Removes a bank account by id. This should be a unique identifying string starting with bank_.
Manage bank accounts that will be used for mailing cheques.
\nThe id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.\nrequired
The id for which bank account will be used for the cheque.
required
The amount for which the cheque is issued for. Must be specified in cents.
\nrequired
A memo to be included on the cheque
\noptional
An HTML message to print on the same page as the cheque.
\noptional
The cheque number.
\noptional
A publicly accessible image URL to be printed on the cheque.
\noptional
Indicates extra services for the letter. See certified and registered mail.\noptional
A 3-letter code representing the currency of amount.
optional
See express shipping.
\n","type":"text"},{"key":"sendDate","value":"2023-02-16T15:40:35.873Z","description":"The desired date for the letter to be sent out.
\noptional
Defaults to first_class. See mailing class.
optional
A description for the cheque.
\noptional
See merge variables.
\noptional
See metadata.
\noptional
Default size will be chosen based on the destination country, if not provided. Indicates the cheque size for the cheque being created. See cheque size
\noptional
Create a cheque order. Note that the number field is optional when creating a cheque. We will automatically generate sequential values for cheques where it is missing.
Also keep in mind that amount must be specified in cents.
The currencyCode of the cheque will be set automatically based on the given bank account's bankCountryCode. If the bank account is a US bank account, then the currency will automatically be USD, and likewise for Canada.
You can also supply a logo parameter which must be a publicly accessible URL to an image. We recommend this image is at least 280px x 280px to be 300 DPI.
See expansions.
\noptional
The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.\nrequired
The id for which bank account will be used for the cheque.
required
The amount for which the cheque is issued for. Must be specified in cents.
\nrequired
The HTML content to be used for the cheque.
\nrequired
A memo to be included on the cheque
\noptional
An HTML message to print on the same page as the cheque.
\noptional
The cheque number.
\noptional
A publicly accessible image URL to be printed on the cheque.
\noptional
Indicates extra services for the letter. See certified and registered mail.\noptional
A 3-letter code representing the currency of amount.
optional
See express shipping.
\n","type":"text"},{"key":"sendDate","value":"2023-02-16T15:40:35.873Z","description":"The desired date for the letter to be sent out.
\noptional
Defaults to first_class. See mailing class.
optional
A description for the cheque.
\noptional
See merge variables.
\noptional
See metadata.
\noptional
Default size will be chosen based on the destination country, if not provided. Indicates the cheque size for the cheque being created. See cheque size
\noptional
Indicates whether the letter will be printed in color or not.\noptional Default: false
Create a cheque with an attached letter. In this case, the letter is specified via raw HTML.
This letter will be black-and-white and will be inserted into the same envelope as the cheque.
See expansions.
\noptional
The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.\nrequired
The id for which bank account will be used for the cheque.
required
The amount for which the cheque is issued for. Must be specified in cents.
\nrequired
The id for the template which will be used for the attached letter.
required
A memo to be included on the cheque
\noptional
An HTML message to print on the same page as the cheque.
\noptional
The cheque number.
\noptional
A publicly accessible image URL to be printed on the cheque.
\noptional
Indicates extra services for the letter. See certified and registered mail.\noptional
A 3-letter code representing the currency of amount.
optional
See express shipping.
\n","type":"text"},{"key":"sendDate","value":"2023-02-16T15:40:35.873Z","description":"The desired date for the letter to be sent out.
\noptional
Defaults to first_class. See mailing class.
optional
A description for the cheque.
\noptional
See merge variables.
\noptional
See metadata.
\noptional
Default size will be chosen based on the destination country, if not provided. Indicates the cheque size for the cheque being created. See cheque size
\noptional
Create a cheque with an attached letter. In this case, the letter is specified via a template id.
This letter will be black-and-white and will be inserted into the same envelope as the cheque.
See expansions.
\noptional
See expansions.
\noptional
Indicates whether the letter will be printed in color or not.\noptional Default: false
The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
required
The id for which bank account will be used for the cheque.
required
The amount for which the cheque is issued for. Must be specified in cents.
\nrequired
An uploaded PDF to be used for the attached letter.
\nrequired
A memo to be included on the cheque
\noptional
An HTML message to print on the same page as the cheque.
\noptional
The cheque number.
\noptional
A publicly accessible image URL to be printed on the cheque.
\noptional
Indicates extra services for the letter. See certified and registered mail.
\noptional
A 3-letter code representing the currency of amount.
optional
See express shipping.
\n","type":"text"},{"key":"sendDate","value":"2023-02-16T15:40:35.873Z","description":"The desired date for the letter to be sent out.
\noptional
Defaults to first_class. See mailing class.
optional
A description for the cheque.
\noptional
See merge variables.
\noptional
See metadata.
\noptional
Default size will be chosen based on the destination country, if not provided. Indicates the cheque size for the cheque being created. See cheque size
\noptional
Indicates whether the letter will be printed in color or not.\noptional Default: false
Create a cheque with an attached letter. In this case, the letter is created from an uploaded PDF.
This letter will be black-and-white and will be inserted into the same envelope as the cheque.
See expansions.
\noptional
The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.
required
The id for which bank account will be used for the cheque.
required
The amount for which the cheque is issued for. Must be specified in cents.
\nrequired
A publicly accesibl link to a PDF to be used for the attached letter.
\nrequired
A memo to be included on the cheque
\noptional
An HTML message to print on the same page as the cheque.
\noptional
The cheque number.
\noptional
A publicly accessible image URL to be printed on the cheque.
\noptional
Indicates extra services for the letter. See certified and registered mail.
\noptional
A 3-letter code representing the currency of amount.
optional
The desired date for the letter to be sent out.
\noptional
See express shipping.
\n","type":"text"},{"key":"description","value":"My cheque with uplaoded pdf","description":"A description for the cheque.
\noptional
See merge variables.
\noptional
See metadata.
\noptional
Defaults to first_class. See mailing class.
optional
Default size will be chosen based on the destination country, if not provided. Indicates the cheque size for the cheque being created. See cheque size
\noptional
Indicates whether the letter will be printed in color or not.\noptional Default: false
Create a cheque with an attached letter. In this case, the letter is created from an uploaded PDF.
This letter will be black-and-white and will be inserted into the same envelope as the cheque.
See expansions.
\noptional
The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.\nrequired
The id for which bank account will be used for the cheque.
required
The amount for which the cheque is issued for. Must be specified in cents.
\nrequired
A memo to be included on the cheque
\noptional
An HTML message to print on the same page as the cheque.
\noptional
The cheque number.
\noptional
A publicly accessible image URL to be printed on the cheque.
\noptional
Indicates extra services for the letter. See certified and registered mail.\noptional
A 3-letter code representing the currency of amount.
optional
See express shipping.
\n","type":"text"},{"key":"sendDate","value":"2023-02-16T15:40:35.873Z","description":"The desired date for the letter to be sent out.
\noptional
Defaults to first_class. See mailing class.
optional
A description for the cheque.
\noptional
See merge variables.
\noptional
See metadata.
\noptional
Default size will be chosen based on the destination country, if not provided. Indicates the cheque size for the cheque being created. See cheque size
\noptional
Create a cheque with a return envelope.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"See expansions.
\noptional
The id or contact object of the receiver. You can either pass a contact object or a contact's id.
required
The id or contact object of the sender. You can either pass a contact object or a contact's id.\nrequired
This field must be passed in to create a digital-only cheque. The watermark must be passed in as such - \"digitalOnly\": {\"watermark\": \"Test\"}
optional
The id for which bank account will be used for the cheque.
required
The amount for which the cheque is issued for. Must be specified in cents.
\nrequired
A memo to be included on the cheque
\noptional
An HTML message to print on the same page as the cheque.
\noptional
The cheque number.
\noptional
A publicly accessible image URL to be printed on the cheque.
\noptional
A 3-letter code representing the currency of amount.
optional
A description for the cheque.
\noptional
See merge variables.
\noptional
See metadata.
\noptional
If the to contact is omitted, this information will be used as the cheque payee name, and the address lines will be omitted. Available for digital cheques only.
optional
Create a Digital Check. Digital Checks allow you to create digital copies of checks that can be sent electronically (for example, through e-mail) or printed by yourself. They use the same standard template as our postal cheques. The Digital Checks created through our API will not be sent out. They will instead be created with a cancelled status and a cancellation reason of digital_only.
There are two PDFs that will be generated: a preview PDF that has a watermark over the cheque, which is the watermark passed in the initial POST call, and the deposit-ready PDF without the watermark and the full bank account number on the cheque.
\nThe PDFs are not generated immediately as the API call is made. To be notified when they are available, you can utilize our webhook functionality. You will be notified when the PDFs are available with a cheque.updated event.
To retrieve the deposit-ready PDF, you will need to call this GET endpoint. To learn more about this feature, you can visit our README guide.
You can now also omit the to contact entirely by using the digitalOnly.payee.name field. This allows you to display only the payee's name on the cheque without requiring any mailing address. This is useful when no physical recipient address is needed.
To create Digital Checks, the feature needs to be enabled for your organization; please reach out to support@postgrid.com.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"See expansions.
\noptional
Retrieves a cheque order based on the passed id. The id should be a unique identifying string starting with cheque_.
See expansions.
\noptional
The id of the desired cheque.
required
Returns the cheque object with the depositReadyPDFURL field, which links to the PDF version of a cheque that is non-watermarked and includes the full account number. It also contains the url field which links to the preview PDF of the E-Check. This endpoint can only be called by users with admin permission, which can be granted by the owner of your PostGrid account.
The id of the desired digital-only cheque
List all cheque orders.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"Cancels a cheque by id. This should be a unique identifying string starting with cheque_.
A note for the cancellation of the cheque.\nrequired
Cancels the specified cheque by id with a note describing the reason for cancellation. The id should be a unique identifying string starting with cheque_. The note should be a string.
The id of the cheque to be deleted.\nrequired
Progress the desired test cheque by id to the next status. This should be a unique identifying string starting with cheque. This can be used to test webhooks.
Note that this will fail with an invalid_progression_error if the status is one of completed or cancelled.
Create and manage cheque orders.
\nAll the events that the webhook will receive. See webhook event types.
\nrequired
The trigger URL of the webhook. This must be HTTPS.
\nrequired
A description for the webhook.
\noptional
See metadata.
\noptional
You can specify a secret to use when creating the webhook. Note that this must be at least 20 characters long and contain no spaces.
\noptional
Creates a new webhook.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"Whether or not this webhook is enabled.
\noptional
The trigger URL of the webhook. This must be HTTPS.
\nrequired
All the events that the webhook will receive. See webhook event types.
\noptional
A description for the webhook.
\noptional
See metadata.
\noptional
An updated secret value for the webhook. Must be at least 20 characters long and contain no spaces.
\noptional
Updates a webhook given by :id. The id should be a unique identifying string that starts with webhook_.
The id of the webhook which you wish to update.
required
Gets a webhook by its id. This should be a unique identifying string starting with webhook_.
Gets all webhooks for the current user.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"List previous invocations of this webhook by id. This should be a unique identifying string starting with webhook_. PostGrid tracks the general details about the invocation and what the response status code was.
The id of the webhook.
required
Deletes a webhook by its id. This should be a unique identifying string starting with webhook_.
Create and manage webhooks. Webhooks can be used to notify your application when events occur in PostGrid. For example, you may use a letter.updated webhook to receive a notification when a letter has been processed for delivery.
Every webhook has a secret and this is used to sign the payload of the event.
You can choose what format you want the payload to be delivered in. By default, the webhook payload will be delivered as a as a JSON Web Token. When you receive the event, you can verify it using a JWT library available for your particular language (using the HMAC SHA256 Algorithm). There are many off-the-shelf solutions you can use.
\nYou can alternatively choose to receive a JSON payload. In this case, you'll also receive a PostGrid-Signature HTTP header along with the payload.
You must respond with a 200 status from your webhook. Otherwise, PostGrid will retry the webhook up to 3 times. First, after 1 hour, then 2 hours, then 4 hours. We will also keep track of every invocation and its response status. You can retrieve data about prior invocations using the webhook invocations list endpoint below.
This is the payload that PostGrid sends when it invokes your webhook. Note that if you choose jwt as the payload type for your webhook, you will have to verify/decode the JWT before you can access this payload.
A contact ID or a contact object containing the address that will be printed onto the return envelope.
\n","type":"text"}]},"url":"https://api.postgrid.com/print-mail/v1/return_envelopes","description":"Creates a new return envelope.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"Gets a list of return envelopes for the user.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"Used for traversing pages. See lists and pagination.
\noptional
Limits the number of resources returned. See lists and pagination.
\noptional
Searches the data for the given input. See search.
\noptional
Gets the information for a return envelope by id. This should be a unique identifying string starting with return_envelope_.
You can use the return envelopes API to create and manage return envelopes. These are envelopes that are sent along with your mail (if specified) and allow your recipients to send mail to a particular address without having to purchase their own envelopes/stamps.
\nNote that you must order return envelopes and wait for the order to be filled before you can use them. You can manage these return envelope orders via the API as well as the dashboard.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"The quantity of return envelopes ordered. Minimum 5000.
\nrequired
A description for the order of return envelopes.
\noptional
See metadata.
\noptional
Creates a batch order of return envelopes.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"Gets a list of return envelope orders for the user.
\n","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"The id of the return envelope of which orders you'd like to retrieve.
required
Gets a specific return envelope order by return envelope id as id and return envelope order id as orderID.
Must be returnEnvelope if supplied. See expandables.
optional
The id of the return envelope.
required
The id of the return envelope order.
required
Fills the return envelope by id, for the return envelope order by orderID in testing.
The id for the return envelope should be a unique identifying string starting with return_envelope_.
The id for the return envelope order should be a unique identifying string starting with return_envelope_order_.
The id of the return envelope.
required
The id of the return envelope order.
required
Cancels a return envelope by id and return envelope order by orderID.
The id for the return envelope should be a unique identifying string starting with return_envelope_.
The id for the return envelope order should be a unique identifying string starting with return_envelope_order_.
Must be returnEnvelope if provided. See expandables.
optional
Specifies the type of event to list. See event types.
\n","type":"text/plain"},"key":"type[]","value":"letter.created"},{"description":{"content":"Used for traversing pages.
\n","type":"text/plain"},"key":"skip","value":"1"},{"description":{"content":"Limits the number of resources returned.
\n","type":"text/plain"},"key":"limit","value":"2"}],"variable":[]}},"response":[{"id":"bde06cc0-7398-4b17-b015-cf6da0ea089e","name":"List Events","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.postgrid.com/print-mail/v1/events?type[]=letter.created&skip=1&limit=2","protocol":"https","host":["api","postgrid","com"],"path":["print-mail","v1","events"],"query":[{"key":"type[]","value":"letter.created","description":"Specifies the type of event to list. See [event types](#204bd5a0-9d1f-417c-aa21-1d2e1a06e8b0)."},{"key":"skip","value":"1","description":"Used for traversing pages."},{"key":"limit","value":"2","description":"Limits the number of resources returned."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 May 2023 15:20:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-powered-by","value":"Express"},{"key":"vary","value":"Origin"},{"key":"access-control-allow-credentials","value":"true"},{"key":"etag","value":"W/\"f59-etmPdyPOuTmAdav4lco0hxVuC4Q\""},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=Rr%2BfDcdPfckCtENlDUfOBKP9sxCrvuVYUbuVUoy10oAWPi7ShmAR9ITJ8NGhEuHXtImC4X7ycTITy%2Fhc8hljP4VZclcSsVWRZFw%2BoMbJK26DpNnEQ6cYw5fzpcEvjyf7hhQM\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7cefb9687a7720be-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"object\": \"list\",\n \"limit\": 2,\n \"skip\": 1,\n \"totalCount\": 196111,\n \"data\": [\n {\n \"id\": \"event_r1nfP4xAacyqMYtt7PeyFD\",\n \"object\": \"event\",\n \"live\": false,\n \"type\": \"letter.created\",\n \"data\": {\n \"id\": \"letter_rqfnwvzq5TUsYR2r6L9V8X\",\n \"object\": \"letter\",\n \"live\": false,\n \"addressPlacement\": \"top_first_page\",\n \"color\": false,\n \"description\": \"letter test 2\",\n \"doubleSided\": false,\n \"envelopeType\": \"standard_double_window\",\n \"express\": false,\n \"extraService\": \"certified\",\n \"from\": {\n \"id\": \"contact_wCVRSWWYjx6QHF8Z2kisUA\",\n \"object\": \"contact\",\n \"addressLine1\": \"2 PICKWICK PLAZA\",\n \"addressLine2\": \"\",\n \"addressStatus\": \"verified\",\n \"city\": \"GREENWICH\",\n \"companyName\": \"Interactive Brokers LLC\",\n \"country\": \"UNITED STATES\",\n \"countryCode\": \"US\",\n \"description\": \"1097916\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"jobTitle\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"amount\": 2071.28,\n \"chequeNumber\": null,\n \"memo\": \"FBO Daniel Devore Roth IRA U5039335\",\n \"variable1\": \"\",\n \"variable2\": \"\"\n },\n \"phoneNumber\": \"\",\n \"postalOrZip\": \"6831\",\n \"provinceOrState\": \"CT\"\n },\n \"mailingClass\": \"first_class\",\n \"mergeVariables\": {\n \"amount\": 732.11,\n \"chequeNumber\": null,\n \"memo\": \"David Becker Distribution\",\n \"variable1\": \"\",\n \"variable2\": \"\"\n },\n \"metadata\": {\n \"postgrid_dashboard\": \"\"\n },\n \"pageCount\": 1,\n \"sendDate\": \"2023-05-29T03:59:59.999Z\",\n \"size\": \"us_letter\",\n \"status\": \"ready\",\n \"template\": \"template_g37s8aKWcTA96YCanSwTe7\",\n \"to\": {\n \"id\": \"contact_j4UQMhBkq6mz2Vvj2coLwX\",\n \"object\": \"contact\",\n \"addressLine1\": \"27571 SANDY SHORES DR SW\",\n \"addressLine2\": \"\",\n \"addressStatus\": \"verified\",\n \"city\": \"VASHON\",\n \"companyName\": \"\",\n \"country\": \"UNITED STATES\",\n \"countryCode\": \"US\",\n \"description\": \"\",\n \"email\": \"\",\n \"firstName\": \"David\",\n \"jobTitle\": \"\",\n \"lastName\": \"Becker\",\n \"metadata\": {\n \"amount\": 732.11,\n \"chequeNumber\": null,\n \"memo\": \"David Becker Distribution\",\n \"variable1\": \"\",\n \"variable2\": \"\"\n },\n \"phoneNumber\": \"\",\n \"postalOrZip\": \"98070\",\n \"provinceOrState\": \"WA\"\n },\n \"url\": \"https://pg-prod-bucket-1.s3.amazonaws.com/test/letter_rqfnwvzq5TUsYR2r6L9V8X?AWSAccessKeyId=AKIA5GFUILSULWTWCR64&Expires=1685374558&Signature=LfgizJyFWFcBilYV46nBtad%2Fwx8%3D\",\n \"createdAt\": \"2023-05-28T23:29:45.206Z\",\n \"updatedAt\": \"2023-05-29T05:30:31.404Z\"\n }\n },\n {\n \"id\": \"event_8Gv6ekFotgQn2BQ15MhNgk\",\n \"object\": \"event\",\n \"live\": false,\n \"type\": \"letter.created\",\n \"data\": {\n \"id\": \"letter_rqfnwvzq5TUsYR2r6L9V8X\",\n \"object\": \"letter\",\n \"live\": false,\n \"addressPlacement\": \"top_first_page\",\n \"color\": false,\n \"description\": \"letter test 2\",\n \"doubleSided\": false,\n \"envelopeType\": \"standard_double_window\",\n \"express\": false,\n \"extraService\": \"certified\",\n \"from\": {\n \"id\": \"contact_wCVRSWWYjx6QHF8Z2kisUA\",\n \"object\": \"contact\",\n \"addressLine1\": \"2 PICKWICK PLAZA\",\n \"addressLine2\": \"\",\n \"addressStatus\": \"verified\",\n \"city\": \"GREENWICH\",\n \"companyName\": \"Interactive Brokers LLC\",\n \"country\": \"UNITED STATES\",\n \"countryCode\": \"US\",\n \"description\": \"1097916\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"jobTitle\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"amount\": 2071.28,\n \"chequeNumber\": null,\n \"memo\": \"FBO Daniel Devore Roth IRA U5039335\",\n \"variable1\": \"\",\n \"variable2\": \"\"\n },\n \"phoneNumber\": \"\",\n \"postalOrZip\": \"6831\",\n \"provinceOrState\": \"CT\"\n },\n \"mailingClass\": \"first_class\",\n \"mergeVariables\": {\n \"amount\": 732.11,\n \"chequeNumber\": null,\n \"memo\": \"David Becker Distribution\",\n \"variable1\": \"\",\n \"variable2\": \"\"\n },\n \"metadata\": {\n \"postgrid_dashboard\": \"\"\n },\n \"pageCount\": 1,\n \"sendDate\": \"2023-05-29T03:59:59.999Z\",\n \"size\": \"us_letter\",\n \"status\": \"ready\",\n \"template\": \"template_g37s8aKWcTA96YCanSwTe7\",\n \"to\": {\n \"id\": \"contact_j4UQMhBkq6mz2Vvj2coLwX\",\n \"object\": \"contact\",\n \"addressLine1\": \"27571 SANDY SHORES DR SW\",\n \"addressLine2\": \"\",\n \"addressStatus\": \"verified\",\n \"city\": \"VASHON\",\n \"companyName\": \"\",\n \"country\": \"UNITED STATES\",\n \"countryCode\": \"US\",\n \"description\": \"\",\n \"email\": \"\",\n \"firstName\": \"David\",\n \"jobTitle\": \"\",\n \"lastName\": \"Becker\",\n \"metadata\": {\n \"amount\": 732.11,\n \"chequeNumber\": null,\n \"memo\": \"David Becker Distribution\",\n \"variable1\": \"\",\n \"variable2\": \"\"\n },\n \"phoneNumber\": \"\",\n \"postalOrZip\": \"98070\",\n \"provinceOrState\": \"WA\"\n },\n \"url\": \"https://pg-prod-bucket-1.s3.amazonaws.com/test/letter_rqfnwvzq5TUsYR2r6L9V8X?AWSAccessKeyId=AKIA5GFUILSULWTWCR64&Expires=1685374558&Signature=LfgizJyFWFcBilYV46nBtad%2Fwx8%3D\",\n \"createdAt\": \"2023-05-28T23:29:45.206Z\",\n \"updatedAt\": \"2023-05-29T05:30:31.404Z\"\n }\n }\n ]\n}"}],"_postman_id":"4711290c-ef54-4632-9af6-12768ce8c7e8"}],"id":"79202d3f-0f30-4cef-8a98-048ad02752f1","description":"View events related to letters, cheques, postcards, and return envelopes. An event is created whenever a webhook is triggered. For example, if a webhook is created that listens to letter.updated events and the delivery status of a letter is updated, an event detailing the updated fields will get created.
The template you want to edit.
\nrequired
The link that the Back button should navigate to. If you are iframing the editor, you should avoid supplying this so the back button is hidden.
\noptional
Override the title of the editor. By default, the title is your template's description.
\noptional
Note that if no backURL is supplied, PostGrid removes the Back button from the editor page. This is ideal for when you iframe the editor.
You can use template editor sessions to bring the capabilities of our template editor to your website. When you create a session, you provide the template which you want to edit, and we return a session with a url that you can iframe or redirect your customers to.
When users save their changes in the editor session, it will update the underlying template. Note that sessions are only valid for 24 hours, after which point they are automatically deleted for security reasons.
\nYou can have multiple sessions active for the same template at the same time. In general, we recommend creating a new session every time you present our editor to your users.
\nNOTE You can only use the template editor to modify templates created using the template editor/template editor sessions. A template created using HTML directly will result in a blank template editor session (saving in this editor would override the HTML).
\nThe base template for URLs generated by this Tracker
\n","type":"text"},{"key":"urlExpireAfterDays","value":"30","description":"Indicates the number of days a Tracker's generated URLs will remain valid after its creation
\n","type":"text"}]},"url":"https://api.postgrid.com/print-mail/v1/trackers","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"The base template for URLs generated by this Tracker
\n","type":"text"},{"key":"urlExpireAfterDays","value":"90","description":"Indicates the number of days a Tracker's generated URLs will remain valid after its creation
\n","type":"text"}]},"url":"https://api.postgrid.com/print-mail/v1/trackers/:id","auth":{"type":"apikey","apikey":{"value":"{{example-api-key}}","key":"Create and manage Trackers.
\nTrackers can be used to track interactions in your orders through personalized URLs and QR codes.
\nAs a brief introduction to using Trackers in your orders, a QR code can be generated by using the Tracker's ID as a merge variable in your orders HTML and Templates. The following example HTML uses Trackers to generate personalized URLs (PURLs) in your orders.
\nSee the following guide for more details: https://postgrid.readme.io/reference/trackers-1
\n