PostGrid Print & Mail API Reference

Official Node.js SDK: https://github.com/postgrid/postgrid-node

AddressVerification

Types:

• Errors
• Status
• AddressVerificationVerifyResponse

Methods:

• POST /v1/addver/verifications — client.addressVerification.verify({ …params }) -> AddressVerificationVerifyResponse

IntlAddressVerification

Types:

• IntlAddressVerificationVerifyResponse

Methods:

• POST /v1/intl_addver/verifications — client.intlAddressVerification.verify({ …params }) -> IntlAddressVerificationVerifyResponse

PrintMail

BankAccounts

Types:

• BankAccount
• BankAccountCountryCode
• BankAccountDeleteResponse

Methods:

• POST /print-mail/v1/bank_accounts — client.printMail.bankAccounts.create({ …params }) -> BankAccount
• GET /print-mail/v1/bank_accounts/{id} — client.printMail.bankAccounts.retrieve(id) -> BankAccount
• GET /print-mail/v1/bank_accounts — client.printMail.bankAccounts.list({ …params }) -> BankAccountsSkipLimit
• DELETE /print-mail/v1/bank_accounts/{id} — client.printMail.bankAccounts.delete(id) -> BankAccountDeleteResponse

Campaigns

Types:

• Campaign
• CampaignDeleteResponse

Methods:

• POST /print-mail/v1/campaigns — client.printMail.campaigns.create({ …params }) -> Campaign
• GET /print-mail/v1/campaigns/{id} — client.printMail.campaigns.retrieve(id) -> Campaign
• POST /print-mail/v1/campaigns/{id} — client.printMail.campaigns.update(id, { …params }) -> Campaign
• GET /print-mail/v1/campaigns — client.printMail.campaigns.list({ …params }) -> CampaignsSkipLimit
• DELETE /print-mail/v1/campaigns/{id} — client.printMail.campaigns.delete(id) -> CampaignDeleteResponse
• POST /print-mail/v1/campaigns/{id}/send — client.printMail.campaigns.send(id, { …params }) -> Campaign

Cheques

Types:

• Cheque
• ChequeSize
• DigitalOnly
• ChequeRetrieveURLResponse

Methods:

• POST /print-mail/v1/cheques — client.printMail.cheques.create({ …params }) -> Cheque
• GET /print-mail/v1/cheques/{id} — client.printMail.cheques.retrieve(id) -> Cheque
• GET /print-mail/v1/cheques — client.printMail.cheques.list({ …params }) -> ChequesSkipLimit
• DELETE /print-mail/v1/cheques/{id} — client.printMail.cheques.delete(id) -> Cheque
• GET /print-mail/v1/cheques/{id}/url — client.printMail.cheques.retrieveURL(id) -> ChequeRetrieveURLResponse
• GET /print-mail/v1/cheques/{id}/with_deposit_ready_pdf — client.printMail.cheques.retrieveWithDepositReadyPdf(id) -> Cheque

Contacts

Types:

• Contact
• ContactCreate
• ContactDeleteResponse

Methods:

• POST /print-mail/v1/contacts — client.printMail.contacts.create({ …params }) -> Contact
• GET /print-mail/v1/contacts/{id} — client.printMail.contacts.retrieve(id) -> Contact
• GET /print-mail/v1/contacts — client.printMail.contacts.list({ …params }) -> ContactsSkipLimit
• DELETE /print-mail/v1/contacts/{id} — client.printMail.contacts.delete(id) -> ContactDeleteResponse

Letters

Types:

• AddressPlacement
• AttachedPdf
• Letter
• LetterSize
• PlasticCard
• LetterRetrieveURLResponse

Methods:

• POST /print-mail/v1/letters — client.printMail.letters.create({ …params }) -> Letter
• GET /print-mail/v1/letters/{id} — client.printMail.letters.retrieve(id) -> Letter
• GET /print-mail/v1/letters — client.printMail.letters.list({ …params }) -> LettersSkipLimit
• DELETE /print-mail/v1/letters/{id} — client.printMail.letters.delete(id) -> Letter
• GET /print-mail/v1/letters/{id}/url — client.printMail.letters.retrieveURL(id) -> LetterRetrieveURLResponse

MailingListImports

Types:

• FileType
• MailingListImportResponse
• VerificationStatusCount
• MailingListImportDeleteResponse

Methods:

• POST /print-mail/v1/mailing_list_imports — client.printMail.mailingListImports.create({ …params }) -> MailingListImportResponse
• GET /print-mail/v1/mailing_list_imports/{id} — client.printMail.mailingListImports.retrieve(id) -> MailingListImportResponse
• POST /print-mail/v1/mailing_list_imports/{id} — client.printMail.mailingListImports.update(id, { …params }) -> MailingListImportResponse
• GET /print-mail/v1/mailing_list_imports — client.printMail.mailingListImports.list({ …params }) -> MailingListImportResponsesSkipLimit
• DELETE /print-mail/v1/mailing_list_imports/{id} — client.printMail.mailingListImports.delete(id) -> MailingListImportDeleteResponse

MailingLists

Types:

• MailingList
• MailingListUpdate
• MailingListDeleteResponse

Methods:

• POST /print-mail/v1/mailing_lists — client.printMail.mailingLists.create({ …params }) -> MailingList
• GET /print-mail/v1/mailing_lists/{id} — client.printMail.mailingLists.retrieve(id) -> MailingList
• POST /print-mail/v1/mailing_lists/{id} — client.printMail.mailingLists.update(id, { …params }) -> MailingListUpdate
• GET /print-mail/v1/mailing_lists — client.printMail.mailingLists.list({ …params }) -> MailingListsSkipLimit
• DELETE /print-mail/v1/mailing_lists/{id} — client.printMail.mailingLists.delete(id) -> MailingListDeleteResponse
• POST /print-mail/v1/mailing_lists/{id}/jobs — client.printMail.mailingLists.jobs(id, { …params }) -> MailingList

OrderProfiles

OrderProfiles.Cheques

Types:

• ChequeProfile
• CurrencyCode
• ChequeListResponse
• ChequeDeleteResponse

Methods:

• POST /print-mail/v1/order_profiles/cheques — client.printMail.orderProfiles.cheques.create({ …params }) -> ChequeProfile
• GET /print-mail/v1/order_profiles/cheques/{id} — client.printMail.orderProfiles.cheques.retrieve(id, { …params }) -> ChequeProfile
• POST /print-mail/v1/order_profiles/cheques/{id} — client.printMail.orderProfiles.cheques.update(id, { …params }) -> ChequeProfile
• GET /print-mail/v1/order_profiles/cheques — client.printMail.orderProfiles.cheques.list({ …params }) -> ChequeListResponsesSkipLimit
• DELETE /print-mail/v1/order_profiles/cheques/{id} — client.printMail.orderProfiles.cheques.delete(id) -> ChequeDeleteResponse

OrderProfiles.Letters

Types:

• LetterProfile
• LetterDeleteResponse

Methods:

• POST /print-mail/v1/order_profiles/letters — client.printMail.orderProfiles.letters.create({ …params }) -> LetterProfile
• GET /print-mail/v1/order_profiles/letters/{id} — client.printMail.orderProfiles.letters.retrieve(id, { …params }) -> LetterProfile
• POST /print-mail/v1/order_profiles/letters/{id} — client.printMail.orderProfiles.letters.update(id, { …params }) -> LetterProfile
• GET /print-mail/v1/order_profiles/letters — client.printMail.orderProfiles.letters.list({ …params }) -> LetterProfilesSkipLimit
• DELETE /print-mail/v1/order_profiles/letters/{id} — client.printMail.orderProfiles.letters.delete(id) -> LetterDeleteResponse

OrderProfiles.Postcards

Types:

• PostcardProfile
• PostcardSize
• PostcardDeleteResponse

Methods:

• POST /print-mail/v1/order_profiles/postcards — client.printMail.orderProfiles.postcards.create({ …params }) -> PostcardProfile
• GET /print-mail/v1/order_profiles/postcards/{id} — client.printMail.orderProfiles.postcards.retrieve(id, { …params }) -> PostcardProfile
• POST /print-mail/v1/order_profiles/postcards/{id} — client.printMail.orderProfiles.postcards.update(id, { …params }) -> PostcardProfile
• GET /print-mail/v1/order_profiles/postcards — client.printMail.orderProfiles.postcards.list({ …params }) -> PostcardProfilesSkipLimit
• DELETE /print-mail/v1/order_profiles/postcards/{id} — client.printMail.orderProfiles.postcards.delete(id) -> PostcardDeleteResponse

OrderProfiles.SelfMailers

Types:

• SelfMailerProfile
• SelfMailerSize
• SelfMailerDeleteResponse

Methods:

• POST /print-mail/v1/order_profiles/self_mailers — client.printMail.orderProfiles.selfMailers.create({ …params }) -> SelfMailerProfile
• GET /print-mail/v1/order_profiles/self_mailers/{id} — client.printMail.orderProfiles.selfMailers.retrieve(id, { …params }) -> SelfMailerProfile
• POST /print-mail/v1/order_profiles/self_mailers/{id} — client.printMail.orderProfiles.selfMailers.update(id, { …params }) -> SelfMailerProfile
• GET /print-mail/v1/order_profiles/self_mailers — client.printMail.orderProfiles.selfMailers.list({ …params }) -> SelfMailerProfilesSkipLimit
• DELETE /print-mail/v1/order_profiles/self_mailers/{id} — client.printMail.orderProfiles.selfMailers.delete(id) -> SelfMailerDeleteResponse

Postcards

Types:

• Postcard
• PostcardRetrieveURLResponse

Methods:

• POST /print-mail/v1/postcards — client.printMail.postcards.create({ …params }) -> Postcard
• GET /print-mail/v1/postcards/{id} — client.printMail.postcards.retrieve(id) -> Postcard
• GET /print-mail/v1/postcards — client.printMail.postcards.list({ …params }) -> PostcardsSkipLimit
• DELETE /print-mail/v1/postcards/{id} — client.printMail.postcards.delete(id) -> Postcard
• GET /print-mail/v1/postcards/{id}/url — client.printMail.postcards.retrieveURL(id) -> PostcardRetrieveURLResponse

Reports

Types:

• DeletedResponse
• Report

Methods:

• POST /print-mail/v1/reports — client.printMail.reports.create({ …params }) -> Report
• GET /print-mail/v1/reports/{id} — client.printMail.reports.retrieve(id) -> Report
• POST /print-mail/v1/reports/{id} — client.printMail.reports.update(id, { …params }) -> Report
• GET /print-mail/v1/reports — client.printMail.reports.list({ …params }) -> ReportsSkipLimit
• DELETE /print-mail/v1/reports/{id} — client.printMail.reports.delete(id) -> DeletedResponse
• POST /print-mail/v1/reports/samples — client.printMail.reports.sample({ …params }) -> ReportSample

Reports.Samples

Types:

• ReportSample
• ReportSampleCreateBase

Methods:

• POST /print-mail/v1/reports/{id}/samples — client.printMail.reports.samples.create(id, { …params }) -> ReportSample

Reports.Exports

Types:

• ReportExport

Methods:

• POST /print-mail/v1/reports/{reportID}/exports — client.printMail.reports.exports.create(reportID, { …params }) -> ReportExport
• GET /print-mail/v1/reports/{reportID}/exports/{exportID} — client.printMail.reports.exports.retrieve(exportID, { …params }) -> ReportExport
• DELETE /print-mail/v1/reports/{reportID}/exports/{exportID} — client.printMail.reports.exports.delete(exportID, { …params }) -> DeletedResponse

SelfMailers

Types:

• SelfMailer
• SelfMailerRetrieveURLResponse

Methods:

• POST /print-mail/v1/self_mailers — client.printMail.selfMailers.create({ …params }) -> SelfMailer
• GET /print-mail/v1/self_mailers/{id} — client.printMail.selfMailers.retrieve(id) -> SelfMailer
• GET /print-mail/v1/self_mailers — client.printMail.selfMailers.list({ …params }) -> SelfMailersSkipLimit
• DELETE /print-mail/v1/self_mailers/{id} — client.printMail.selfMailers.delete(id) -> SelfMailer
• GET /print-mail/v1/self_mailers/{id}/url — client.printMail.selfMailers.retrieveURL(id) -> SelfMailerRetrieveURLResponse

SubOrganizations

Types:

• EmailPreferences
• SubOrganization
• SubOrganizationUpdateResponse
• SubOrganizationRetrieveUsersResponse

Methods:

• GET /print-mail/v1/sub_organizations/{id} — client.printMail.subOrganizations.retrieve(id) -> SubOrganization
• POST /print-mail/v1/sub_organizations — client.printMail.subOrganizations.update({ …params }) -> SubOrganizationUpdateResponse
• GET /print-mail/v1/sub_organizations — client.printMail.subOrganizations.list({ …params }) -> SubOrganizationsSkipLimit
• GET /print-mail/v1/sub_organizations/{id}/users — client.printMail.subOrganizations.retrieveUsers(id, { …params }) -> SubOrganizationRetrieveUsersResponse

Templates

Types:

• Template
• TemplateDeleteResponse

Methods:

• POST /print-mail/v1/templates — client.printMail.templates.create({ …params }) -> Template
• GET /print-mail/v1/templates/{id} — client.printMail.templates.retrieve(id) -> Template
• POST /print-mail/v1/templates/{id} — client.printMail.templates.update(id, { …params }) -> Template
• GET /print-mail/v1/templates — client.printMail.templates.list({ …params }) -> TemplatesSkipLimit
• DELETE /print-mail/v1/templates/{id} — client.printMail.templates.delete(id) -> TemplateDeleteResponse

Summary of Main Endpoints

Contacts

• Create, retrieve, list, delete contacts
• Endpoint: /print-mail/v1/contacts

Postcards

• Create, retrieve, list, delete postcards
• Retrieve preview URL: GET /print-mail/v1/postcards/{id}/url
• Endpoint: /print-mail/v1/postcards

Letters

• Create, retrieve, list, delete letters
• Supports address placement and attached PDFs
• Retrieve preview URL: GET /print-mail/v1/letters/{id}/url
• Endpoint: /print-mail/v1/letters

Templates

• Create, retrieve, update, list, delete templates
• Endpoint: /print-mail/v1/templates

Additional Mail Resources

• Cheques: Create, retrieve, list, delete cheques with deposit-ready PDF support
• SelfMailers: Create, retrieve, list, delete self-mailers with preview URLs
• Campaigns: Create, update, list, delete campaigns with send capability
• Reports: Create, update, retrieve, list, delete reports with sampling and export features
• Mailing Lists: Create, retrieve, update, list, delete mailing lists with import support
• Order Profiles: Manage profiles for Cheques, Letters, Postcards, and SelfMailers
• Bank Accounts: Create, retrieve, list, delete bank accounts
• Sub-Organizations: Retrieve, update, list sub-organizations and their users
• Address Verification: Verify domestic and international addresses