The PostGrid Print & Mail connector lets your AI agent act in each user's PostGrid Print & Mail account. Each user connects their own PostGrid Print & Mail API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 30 · 17 · 1330 read17 write13 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the PostGrid Print & Mail connection
In AgentKit > Connections, create a PostGrid Print & Mail connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'postgrid'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize PostGrid Print & Mail:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'postgrid_bank_accounts_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "postgrid"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize PostGrid Print & Mail:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="postgrid_bank_accounts_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their PostGrid Print & Mail credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolpostgrid_bank_account_getGet one bank account by ID, including its status and details.Read-onlyGet Bank Account
Get one bank account by ID, including its status and details. Returns object, bankName, bankPrimaryLine, bankSecondaryLine, bankCountryCode, accountNumber, routingNumber, transitNumber, routeNumber, caDesignationNumber. Get bank account IDs from postgrid_bank_accounts_list.
Inputs
idstringrequired- ID of the record. Example: bank_account_123456789abcdefghijklm
postgrid_bank_accounts_listList bank accounts, newest first, with search and skip/limit paging.Read-onlyList Bank Accounts
List bank accounts, newest first, with search and skip/limit paging. Returns object, totalCount, skip, limit, data. Use postgrid_bank_account_get for one bank account.
Inputs
limitinteger- Maximum number of records to return. Example: 10
searchstring- Free-text search over the records. Example: Jane
skipinteger- Number of records to skip, for paging. Example: 0
postgrid_campaign_getGet one campaign by ID, including its status and details.Read-onlyGet Campaign
Get one campaign by ID, including its status and details. Returns id, description, metadata, live, createdAt, updatedAt, status, defaultSenderContact, mailingList, createdCount. Get campaign IDs from postgrid_campaigns_list.
Inputs
idstringrequired- ID of the record. Example: campaign_123456789abcdefghijklm
postgrid_campaigns_listList campaigns, newest first, with search and skip/limit paging.Read-onlyList Campaigns
List campaigns, newest first, with search and skip/limit paging. Returns object, totalCount, skip, limit, data. Use postgrid_campaign_get for one campaign.
Inputs
limitinteger- Maximum number of records to return. Example: 10
searchstring- Free-text search over the records. Example: Jane
skipinteger- Number of records to skip, for paging. Example: 0
postgrid_cheque_getGet one cheque by ID, including its status and details.Read-onlyGet Cheque
Get one cheque by ID, including its status and details. Returns status, mergeVariables, trackingNumber, imbStatus, imbZIPCode, imbDate, cancellation, url, id, description. Get cheque IDs from postgrid_cheques_list.
Inputs
idstringrequired- ID of the record. Example: cheque_123456789abcdefghijklm
postgrid_cheque_preview_getGet a temporary URL to the rendered PDF preview of a cheque.Read-onlyGet Cheque Preview
Get a temporary URL to the rendered PDF preview of a cheque. Returns id, object, url. Get cheque IDs from postgrid_cheques_list.
Inputs
idstringrequired- ID of the record. Example: cheque_123456789abcdefghijklm
postgrid_cheques_listList cheques, newest first, with search and skip/limit paging.Read-onlyList Cheques
List cheques, newest first, with search and skip/limit paging. Returns object, totalCount, skip, limit, data. Use postgrid_cheque_get for one cheque.
Inputs
limitinteger- Maximum number of records to return. Example: 10
searchstring- Free-text search over the records. Example: Jane
skipinteger- Number of records to skip, for paging. Example: 0
postgrid_contact_getGet one contact by ID, including its status and details.Read-onlyGet Contact
Get one contact by ID, including its status and details. Returns object, addressLine1, addressLine2, city, provinceOrState, postalOrZip, countryCode, addressStatus, addressErrors, companyName. Get contact IDs from postgrid_contacts_list.
Inputs
idstringrequired- ID of the record. Example: contact_123456789abcdefghijklm
postgrid_contacts_listList contacts, newest first, with search and skip/limit paging.Read-onlyList Contacts
List contacts, newest first, with search and skip/limit paging. Returns object, totalCount, skip, limit, data. Use postgrid_contact_get for one contact.
Inputs
limitinteger- Maximum number of records to return. Example: 10
searchstring- Free-text search over the records. Example: Jane
skipinteger- Number of records to skip, for paging. Example: 0
postgrid_events_listList account events such as letter.created or postcard.updated, optionally filtered by type.Read-onlyList Events
List account events such as letter.created or postcard.updated, optionally filtered by type. Returns object, totalCount, skip, limit, data. Use postgrid_webhooks_list to see where events are delivered.
Inputs
limitinteger- Maximum number of records to return. Example: 10
skipinteger- Number of records to skip, for paging. Example: 0
typearray- An optional list of event types to filter the results by. Example: letter.created
postgrid_letter_getGet one letter by ID, including its status and details.Read-onlyGet Letter
Get one letter by ID, including its status and details. Returns status, mergeVariables, trackingNumber, imbStatus, imbZIPCode, imbDate, cancellation, url, id, description. Get letter IDs from postgrid_letters_list.
Inputs
idstringrequired- ID of the record. Example: letter_123456789abcdefghijklm
postgrid_letter_preview_getGet a temporary URL to the rendered PDF preview of a letter.Read-onlyGet Letter Preview
Get a temporary URL to the rendered PDF preview of a letter. Returns id, object, url. Get letter IDs from postgrid_letters_list.
Inputs
idstringrequired- ID of the record. Example: letter_123456789abcdefghijklm
postgrid_letters_listList letters, newest first, with search and skip/limit paging.Read-onlyList Letters
List letters, newest first, with search and skip/limit paging. Returns object, totalCount, skip, limit, data. Use postgrid_letter_get for one letter.
Inputs
limitinteger- Maximum number of records to return. Example: 10
searchstring- Free-text search over the records. Example: Jane
skipinteger- Number of records to skip, for paging. Example: 0
postgrid_mailing_list_getGet one mailing list by ID, including its status and details.Read-onlyGet Mailing List
Get one mailing list by ID, including its status and details. Returns id, description, metadata, live, createdAt, updatedAt, status, errors. Get mailing list IDs from postgrid_mailing_lists_list.
Inputs
idstringrequired- ID of the record. Example: mailing_list_123456789abcdefghijklm
postgrid_mailing_list_import_getGet one mailing list import by ID, including its status and details.Read-onlyGet Mailing List Import
Get one mailing list import by ID, including its status and details. Returns id, description, metadata, live, createdAt, updatedAt, status, reportURL, errors, notes. Get mailing list import IDs from postgrid_mailing_list_imports_list.
Inputs
idstringrequired- ID of the record. Example: mailing_list_import_123456789abcdefghijklm
postgrid_mailing_list_imports_listList mailing list imports, newest first, with search and skip/limit paging.Read-onlyList Mailing List Imports
List mailing list imports, newest first, with search and skip/limit paging. Returns object, totalCount, skip, limit, data. Use postgrid_mailing_list_import_get for one mailing list import.
Inputs
limitinteger- Maximum number of records to return. Example: 10
searchstring- Free-text search over the records. Example: Jane
skipinteger- Number of records to skip, for paging. Example: 0
postgrid_mailing_lists_listList mailing lists, newest first, with search and skip/limit paging.Read-onlyList Mailing Lists
List mailing lists, newest first, with search and skip/limit paging. Returns object, totalCount, skip, limit, data. Use postgrid_mailing_list_get for one mailing list.
Inputs
limitinteger- Maximum number of records to return. Example: 10
searchstring- Free-text search over the records. Example: Jane
skipinteger- Number of records to skip, for paging. Example: 0
postgrid_postcard_getGet one postcard by ID, including its status and details.Read-onlyGet Postcard
Get one postcard by ID, including its status and details. Returns status, mergeVariables, trackingNumber, imbStatus, imbZIPCode, imbDate, cancellation, url, id, description. Get postcard IDs from postgrid_postcards_list.
Inputs
idstringrequired- ID of the record. Example: postcard_123456789abcdefghijklm
postgrid_postcard_preview_getGet a temporary URL to the rendered PDF preview of a postcard.Read-onlyGet Postcard Preview
Get a temporary URL to the rendered PDF preview of a postcard. Returns id, object, url. Get postcard IDs from postgrid_postcards_list.
Inputs
idstringrequired- ID of the record. Example: postcard_123456789abcdefghijklm
postgrid_postcards_listList postcards, newest first, with search and skip/limit paging.Read-onlyList Postcards
List postcards, newest first, with search and skip/limit paging. Returns object, totalCount, skip, limit, data. Use postgrid_postcard_get for one postcard.
Inputs
limitinteger- Maximum number of records to return. Example: 10
searchstring- Free-text search over the records. Example: Jane
skipinteger- Number of records to skip, for paging. Example: 0
postgrid_self_mailer_getGet one self mailer by ID, including its status and details.Read-onlyGet Self Mailer
Get one self mailer by ID, including its status and details. Returns status, mergeVariables, trackingNumber, imbStatus, imbZIPCode, imbDate, cancellation, url, id, description. Get self mailer IDs from postgrid_self_mailers_list.
Inputs
idstringrequired- ID of the record. Example: self_mailer_123456789abcdefghijklm
postgrid_self_mailer_preview_getGet a temporary URL to the rendered PDF preview of a self mailer.Read-onlyGet Self Mailer Preview
Get a temporary URL to the rendered PDF preview of a self mailer. Returns id, object, url. Get self mailer IDs from postgrid_self_mailers_list.
Inputs
idstringrequired- ID of the record. Example: self_mailer_123456789abcdefghijklm
postgrid_self_mailers_listList self mailers, newest first, with search and skip/limit paging.Read-onlyList Self Mailers
List self mailers, newest first, with search and skip/limit paging. Returns object, totalCount, skip, limit, data. Use postgrid_self_mailer_get for one self mailer.
Inputs
limitinteger- Maximum number of records to return. Example: 10
searchstring- Free-text search over the records. Example: Jane
skipinteger- Number of records to skip, for paging. Example: 0
postgrid_template_getGet one template by ID, including its status and details.Read-onlyGet Template
Get one template by ID, including its status and details. Returns object, html, id, description, metadata, live, createdAt, updatedAt. Get template IDs from postgrid_templates_list.
Inputs
idstringrequired- ID of the record. Example: template_123456789abcdefghijklm
postgrid_templates_listList templates, newest first, with search and skip/limit paging.Read-onlyList Templates
List templates, newest first, with search and skip/limit paging. Returns object, totalCount, skip, limit, data. Use postgrid_template_get for one template.
Inputs
limitinteger- Maximum number of records to return. Example: 10
searchstring- Free-text search over the records. Example: Jane
skipinteger- Number of records to skip, for paging. Example: 0
postgrid_tracker_getGet one tracker by ID, including its status and details.Read-onlyGet Tracker
Get one tracker by ID, including its status and details. Returns object, redirectURLTemplate, urlExpireAfterDays, visitCount, uniqueVisitCount, id, description, metadata, live, createdAt. Get tracker IDs from postgrid_trackers_list.
Inputs
idstringrequired- ID of the record. Example: tracker_123456789abcdefghijklm
postgrid_trackers_listList trackers, newest first, with search and skip/limit paging.Read-onlyList Trackers
List trackers, newest first, with search and skip/limit paging. Returns object, totalCount, skip, limit, data. Use postgrid_tracker_get for one tracker.
Inputs
limitinteger- Maximum number of records to return. Example: 10
searchstring- Free-text search over the records. Example: Jane
skipinteger- Number of records to skip, for paging. Example: 0
postgrid_webhook_getGet one webhook by ID, including its status and details.Read-onlyGet Webhook
Get one webhook by ID, including its status and details. Returns object, url, enabledEvents, payloadFormat, enabled, secret, id, description, metadata, live. Get webhook IDs from postgrid_webhooks_list.
Inputs
idstringrequired- ID of the record. Example: webhook_123456789abcdefghijklm
postgrid_webhook_invocations_listList the delivery attempts of a webhook with their status codes.Read-onlyList Webhook Invocations
List the delivery attempts of a webhook with their status codes. Returns object, totalCount, skip, limit, data. Get webhook IDs from postgrid_webhooks_list.
Inputs
idstringrequired- ID of the record. Example: webhook_123456789abcdefghijklm
limitinteger- Maximum number of records to return. Example: 10
searchstring- Free-text search over the records. Example: Jane
skipinteger- Number of records to skip, for paging. Example: 0
postgrid_webhooks_listList webhooks, newest first, with search and skip/limit paging.Read-onlyList Webhooks
List webhooks, newest first, with search and skip/limit paging. Returns object, totalCount, skip, limit, data. Use postgrid_webhook_get for one webhook.
Inputs
limitinteger- Maximum number of records to return. Example: 10
searchstring- Free-text search over the records. Example: Jane
skipinteger- Number of records to skip, for paging. Example: 0
postgrid_bank_account_createAdd a bank account to draw cheques on, signed with a text signature.WriteCreate Bank Account
Add a bank account to draw cheques on, signed with a text signature. Returns object, bankName, bankPrimaryLine, bankSecondaryLine, bankCountryCode, accountNumber, routingNumber, transitNumber, routeNumber, caDesignationNumber. Use the returned ID as bank_account in postgrid_cheque_create.
Inputs
account_numberstringrequired- The account number of the bank account. Example: 000123456789
bank_country_codestringrequired- The country code of the bank. One of: CA, US. Example: USone of
CAUS bank_namestringrequired- The name of the bank. Example: Example Bank
signature_textstringrequired- The signature text of the bank account. Example: Jane Doe
bank_primary_linestring- The primary address line of the bank. Example: 100 Bank St
bank_secondary_linestring- The secondary address line of the bank. Example: New York, NY 10001
ca_designation_numberstring- The designation number of the bank account (for CA). Example: example
descriptionstring- An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
metadataobject- Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
route_numberstring- The route number of the bank account (for CA). Example: example
routing_numberstring- The routing number of the bank account (for US). Example: 011000015
transit_numberstring- The transit number of the bank account (for CA). Example: example
postgrid_campaign_createCreate a mail campaign that sends one letter, postcard, cheque or self mailer design to every contact in a mailing list.WriteCreate Campaign
Create a mail campaign that sends one letter, postcard, cheque or self mailer design to every contact in a mailing list. Returns id, description, metadata, live, createdAt, updatedAt, status, defaultSenderContact, mailingList, createdCount. Send it with postgrid_campaign_send.
Inputs
mailing_liststringrequired- The ID of the mailing list associated with this campaign. Example: mailing_list_123456789abcdefghijklm
chequeobject- Inline cheque configuration for this campaign. Only one collateral type can be set. Example: {"key": "value"}
default_sender_contactstring- The ID of the default sender contact to use for orders if not specified per recipient. Example: contact_123456789abcdefghijklm
descriptionstring- An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
letterobject- Inline letter configuration for this campaign. Only one collateral type can be set. Example: {"template": "template_123456789abcdefghijklm"}
metadataobject- Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
postcardobject- Inline postcard configuration for this campaign. Only one collateral type can be set. Example: {"key": "value"}
self_mailerobject- Inline self-mailer configuration for this campaign. Only one collateral type can be set. Example: {"key": "value"}
send_datestring- Date the mail piece is sent to print, YYYY-MM-DD; defaults to now. Orders can be cancelled until then. Example: 2026-12-01
postgrid_campaign_sendSend a campaign: create the mail pieces for every contact in its mailing list, now or on a send date.WriteSend Campaign
Send a campaign: create the mail pieces for every contact in its mailing list, now or on a send date. Returns id, description, metadata, live, createdAt, updatedAt, status, defaultSenderContact, mailingList, createdCount. This creates billable mail with a live key. Get campaign IDs from postgrid_campaigns_list.
Inputs
idstringrequired- ID of the record. Example: campaign_123456789abcdefghijklm
send_datestring- Date the mail piece is sent to print, YYYY-MM-DD; defaults to now. Orders can be cancelled until then. Example: 2026-12-01
postgrid_campaign_updateUpdate a draft campaign's mailing list, mail piece settings or sender.WriteUpdate Campaign
Update a draft campaign's mailing list, mail piece settings or sender. Returns id, description, metadata, live, createdAt, updatedAt, status, defaultSenderContact, mailingList, createdCount. Get campaign IDs from postgrid_campaigns_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: campaign_123456789abcdefghijklm
chequeobject- Inline cheque configuration. Setting this will remove other collateral types. Set to null to remove. Example: {"key": "value"}
default_sender_contactstring- The ID of the default sender contact. Set to null to remove. Example: contact_123456789abcdefghijklm
descriptionstring- An optional description for the campaign. Set to null to remove the existing description. Example: Welcome letter batch
letterobject- Inline letter configuration. Setting this will remove other collateral types. Set to null to remove. Example: {"template": "template_123456789abcdefghijklm"}
mailing_liststring- The ID of the mailing list to associate with this campaign. Example: mailing_list_123456789abcdefghijklm
metadataobject- Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
postcardobject- Inline postcard configuration. Setting this will remove other collateral types. Set to null to remove. Example: {"key": "value"}
self_mailerobject- Inline self-mailer configuration. Setting this will remove other collateral types. Set to null to remove. Example: {"key": "value"}
postgrid_cheque_createCreate and mail a cheque drawn on a bank account, with an optional cover letter.WriteCreate Cheque
Create and mail a cheque drawn on a bank account, with an optional cover letter. Returns status, mergeVariables, trackingNumber, imbStatus, imbZIPCode, imbDate, cancellation, url, id, description. Create the bank account first with postgrid_bank_account_create. Amounts are in cents.
Inputs
amountintegerrequired- Cheque amount in cents (10000 = 100.00). Example: 10000
bank_accountstringrequired- The bank account (ID) associated with the cheque. Example: bank_123456789abcdefghijklm
toobjectrequired- Recipient contact as a JSON object: firstName and lastName or companyName, plus addressLine1, optional addressLine2, city, provinceOrState, postalOrZip and countryCode (two-letter). Example: {"firstName": "Jane", "lastName": "Doe", "addressLine1": "145 Mulberry St", "city": "New York", "provinceOrState": "NY", "postalOrZip": "10013", "countryCode": "US"}
descriptionstring- An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
fromobject- Sender (return address) contact as a JSON object with the same fields as the recipient. Example: {"companyName": "Acme Inc", "addressLine1": "20 Bay St", "city": "Toronto", "provinceOrState": "ON", "postalOrZip": "M5J 2N8", "countryCode": "CA"}
letter_htmlstring- The raw HTML content for a letter attached to the cheque, if any. You can supply _either_ this, letterTemplate, or letterPDF, but not more than one. Example: example
letter_templatestring- A Template ID for the letter attached to the cheque, if any. Example: example
mailing_classstring- The mailing class of this order. If not provided, automatically set to first_class. Example: first_classone of
first_classstandard_classexpresscertifiedcertified_return_receiptregisteredusps_first_classusps_standard_classusps_eddmusps_express_2_dayusps_express_3_dayusps_first_class_certifiedusps_first_class_certified_return_receiptusps_first_class_registeredusps_express_3_day_signature_confirmationusps_express_3_day_certifiedusps_express_3_day_certified_return_receiptca_post_lettermailca_post_personalizedca_post_neighbourhood_mailups_express_overnightups_express_2_dayups_express_3_dayroyal_mail_first_classroyal_mail_second_classau_post_second_class memostring- The memo of the cheque. Example: Invoice 1042
merge_variablesobject- Values for the {{variables}} in the HTML or template, as a JSON object. Example: {"firstName": "Jane"}
messagestring- The message of the cheque. Example: Thank you for your business.
metadataobject- Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
numberinteger- The number of the cheque. If you don't provide this, it will automatically be set to an incrementing number starting from 1 across your entire account, ensuring that every cheque has a unique number. Example: 1001
send_datestring- Date the mail piece is sent to print, YYYY-MM-DD; defaults to now. Orders can be cancelled until then. Example: 2026-12-01
postgrid_contact_createCreate a contact (a person or company with a mailing address) to use as a recipient or sender.WriteCreate Contact
Create a contact (a person or company with a mailing address) to use as a recipient or sender. Returns object, addressLine1, addressLine2, city, provinceOrState, postalOrZip, countryCode, addressStatus, addressErrors, companyName. Use contacts to build mailing lists with postgrid_mailing_list_job_submit. Give first_name or company_name.
Inputs
address_line1stringrequired- The first line of the contact's address. Example: 145 Mulberry St
country_codestringrequired- The ISO 3611-1 country code of the contact's address. If omitted, your organization's default country code is used. Example: US
address_line2string- Second line of the contact's address, if applicable. Example: Suite 4
citystring- The city of the contact's address. Example: New York
company_namestring- Company Name. Example: Acme Inc
descriptionstring- An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
emailstring- Email of the contact. Example: jane@example.com
first_namestring- First name of the contact. Example: Jane
force_verified_statusboolean- If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise. Example: false
job_titlestring- Job title of the contact. Example: Office Manager
last_namestring- Last name of the contact. Example: Doe
metadataobject- Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
phone_numberstring- Phone number of the contact. Example: +15555550100
postal_or_zipstring- The postal or ZIP code of the contact's address. Example: 10013
province_or_statestring- Province or state of the contact's address. Example: NY
secretboolean- If true, the contact's details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data. Example: false
skip_verificationboolean- If true, PostGrid will skip running this contact's address through our address verification system. Example: false
postgrid_letter_createCreate and send a printed letter to a recipient, from HTML, a saved template or a PDF URL (give exactly one).WriteCreate Letter
Create and send a printed letter to a recipient, from HTML, a saved template or a PDF URL (give exactly one). Returns status, mergeVariables, trackingNumber, imbStatus, imbZIPCode, imbDate, cancellation, url, id, description. With a test API key nothing is printed or mailed. Use postgrid_letter_cancel before the send date to stop it.
Inputs
fromobjectrequired- Sender (return address) contact as a JSON object with the same fields as the recipient. Example: {"companyName": "Acme Inc", "addressLine1": "20 Bay St", "city": "Toronto", "provinceOrState": "ON", "postalOrZip": "M5J 2N8", "countryCode": "CA"}
toobjectrequired- Recipient contact as a JSON object: firstName and lastName or companyName, plus addressLine1, optional addressLine2, city, provinceOrState, postalOrZip and countryCode (two-letter). Example: {"firstName": "Jane", "lastName": "Doe", "addressLine1": "145 Mulberry St", "city": "New York", "provinceOrState": "NY", "postalOrZip": "10013", "countryCode": "US"}
address_placementstring- The placement of the address on the letter. One of: top_first_page, insert_blank_page. Example: top_first_pageone of
top_first_pageinsert_blank_page colorboolean- Indicates if the letter is in color. Example: false
descriptionstring- An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
double_sidedboolean- Indicates if the letter is double-sided. Example: false
envelopestring- The envelope (ID) for the letter. You can either specify a custom envelope ID or use the default standard envelope. Example: standard
htmlstring- HTML content of the letter. Give exactly one of html, template or pdf. Example: <html><body><p>Hello {{to.firstName}}</p></body></html>
mailing_classstring- The mailing class of this order. If not provided, automatically set to first_class. Example: first_classone of
first_classstandard_classexpresscertifiedcertified_return_receiptregisteredusps_first_classusps_standard_classusps_eddmusps_express_2_dayusps_express_3_dayusps_first_class_certifiedusps_first_class_certified_return_receiptusps_first_class_registeredusps_express_3_day_signature_confirmationusps_express_3_day_certifiedusps_express_3_day_certified_return_receiptca_post_lettermailca_post_personalizedca_post_neighbourhood_mailups_express_overnightups_express_2_dayups_express_3_dayroyal_mail_first_classroyal_mail_second_classau_post_second_class merge_variablesobject- Values for the {{variables}} in the HTML or template, as a JSON object. Example: {"firstName": "Jane"}
metadataobject- Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
paperstring- Premium paper selection used for this letter. Available values include: - standard - premium_paper_letter_standard_white_70lb - premium_paper_letter_standard_white_80lb Not all premium paper options are enabled for all organizations. If omitted, the organization default letter paper is used when configured; otherwise standard. One of: standard, premium_paper_letter_standard_white_70lb, premium_paper_letter_standard_white_80lb. Example: standardone of
standardpremium_paper_letter_standard_white_70lbpremium_paper_letter_standard_white_80lb pdfstring- Public URL of a PDF to print. Give exactly one of html, template or pdf. Example: https://example.com/letter.pdf
send_datestring- Date the mail piece is sent to print, YYYY-MM-DD; defaults to now. Orders can be cancelled until then. Example: 2026-12-01
sizestring- The size of the letter. One of: us_letter, a4. Example: us_letterone of
us_lettera4 templatestring- ID of a saved template (from postgrid_templates_list). Give exactly one of html, template or pdf. Example: template_123456789abcdefghijklm
postgrid_mailing_list_createCreate an empty mailing list.WriteCreate Mailing List
Create an empty mailing list. Returns id, description, metadata, live, createdAt, updatedAt, status, errors. Add contacts with postgrid_mailing_list_job_submit.
Inputs
descriptionstring- An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
metadataobject- Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
postgrid_mailing_list_job_submitAdd or remove contacts (or mailing list imports) on a mailing list as a background job.WriteUpdate Mailing List Contacts
Add or remove contacts (or mailing list imports) on a mailing list as a background job. Returns id, description, metadata, live, createdAt, updatedAt, status, errors. Get contact IDs from postgrid_contacts_list.
Inputs
idstringrequired- ID of the record. Example: mailing_list_123456789abcdefghijklm
add_contactsarray- List of contact IDs to add to the mailing list. Cannot be used with other operations. Example: ["contact_123456789abcdefghijklm"]
add_mailing_list_importsarray- List of mailing list import IDs to add to the mailing list. Cannot be used with other operations. Example: ["value"]
remove_contactsarray- List of contact IDs to remove from the mailing list. Cannot be used with other operations. Example: ["contact_223456789abcdefghijklm"]
remove_mailing_list_importsarray- List of mailing list import IDs to remove from the mailing list. Cannot be used with other operations. Example: ["value"]
postgrid_mailing_list_updateUpdate a mailing list's description or metadata.WriteUpdate Mailing List
Update a mailing list's description or metadata. Returns description, metadata. Get mailing list IDs from postgrid_mailing_lists_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: mailing_list_123456789abcdefghijklm
descriptionstring- An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
metadataobject- Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
postgrid_postcard_createCreate and send a postcard from front and back HTML, two templates or a PDF URL.WriteCreate Postcard
Create and send a postcard from front and back HTML, two templates or a PDF URL. Returns status, mergeVariables, trackingNumber, imbStatus, imbZIPCode, imbDate, cancellation, url, id, description. With a test API key nothing is printed. Use postgrid_postcard_cancel before the send date to stop it.
Inputs
fromobjectrequired- Sender (return address) contact as a JSON object with the same fields as the recipient. Example: {"companyName": "Acme Inc", "addressLine1": "20 Bay St", "city": "Toronto", "provinceOrState": "ON", "postalOrZip": "M5J 2N8", "countryCode": "CA"}
sizestringrequired- The size of the postcard. One of: 6x4, 9x6, 11x6. Example: 6x4one of
6x49x611x6 toobjectrequired- Recipient contact as a JSON object: firstName and lastName or companyName, plus addressLine1, optional addressLine2, city, provinceOrState, postalOrZip and countryCode (two-letter). Example: {"firstName": "Jane", "lastName": "Doe", "addressLine1": "145 Mulberry St", "city": "New York", "provinceOrState": "NY", "postalOrZip": "10013", "countryCode": "US"}
back_htmlstring- The HTML content for the back of the postcard. You can supply _either_ this or backTemplate but not both. Example: <p>Back</p>
back_templatestring- The template ID for the back of the postcard. You can supply _either_ this or backHTML but not both. Example: template_223456789abcdefghijklm
descriptionstring- An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
front_htmlstring- The HTML content for the front of the postcard. You can supply _either_ this or frontTemplate but not both. Example: <p>Front</p>
front_templatestring- The template ID for the front of the postcard. You can supply _either_ this or frontHTML but not both. Example: template_123456789abcdefghijklm
mailing_classstring- The mailing class of this order. If not provided, automatically set to first_class. Example: first_classone of
first_classstandard_classexpresscertifiedcertified_return_receiptregisteredusps_first_classusps_standard_classusps_eddmusps_express_2_dayusps_express_3_dayusps_first_class_certifiedusps_first_class_certified_return_receiptusps_first_class_registeredusps_express_3_day_signature_confirmationusps_express_3_day_certifiedusps_express_3_day_certified_return_receiptca_post_lettermailca_post_personalizedca_post_neighbourhood_mailups_express_overnightups_express_2_dayups_express_3_dayroyal_mail_first_classroyal_mail_second_classau_post_second_class merge_variablesobject- Values for the {{variables}} in the HTML or template, as a JSON object. Example: {"firstName": "Jane"}
metadataobject- Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
paperstring- Premium paper selection used for this postcard. Available values include: - standard - premium_paper_heavy_1_glossy - premium_paper_postcard_uv_glossy_ss - premium_paper_postcard_uv_glossy_ss_120lb - premium_paper_postcard_satin_ds Not all premium paper options are enabled for all organizations. If omitted, the organization default postcard paper is used when configured; otherwise standard. One of: standard, premium_paper_heavy_1_glossy, premium_paper_postcard_uv_glossy_ss, premium_paper_postcard_uv_glossy_ss_120lb, premium_paper_postcard_satin_ds. Example: standardone of
standardpremium_paper_heavy_1_glossypremium_paper_postcard_uv_glossy_sspremium_paper_postcard_uv_glossy_ss_120lbpremium_paper_postcard_satin_ds pdfstring- Public URL of a PDF to print. Give exactly one of html, template or pdf. Example: https://example.com/letter.pdf
send_datestring- Date the mail piece is sent to print, YYYY-MM-DD; defaults to now. Orders can be cancelled until then. Example: 2026-12-01
postgrid_self_mailer_createCreate and send a folded self mailer from inside and outside HTML, templates or a PDF URL.WriteCreate Self Mailer
Create and send a folded self mailer from inside and outside HTML, templates or a PDF URL. Returns status, mergeVariables, trackingNumber, imbStatus, imbZIPCode, imbDate, cancellation, url, id, description. With a test API key nothing is printed. Use postgrid_self_mailer_cancel to stop it.
Inputs
fromobjectrequired- Sender (return address) contact as a JSON object with the same fields as the recipient. Example: {"companyName": "Acme Inc", "addressLine1": "20 Bay St", "city": "Toronto", "provinceOrState": "ON", "postalOrZip": "M5J 2N8", "countryCode": "CA"}
sizestringrequired- The size of the self-mailer. One of: 8.5x11_bifold, 8.5x11_trifold, 9.5x16_trifold. Example: 8.5x11_bifoldone of
8.5x11_bifold8.5x11_trifold9.5x16_trifold toobjectrequired- Recipient contact as a JSON object: firstName and lastName or companyName, plus addressLine1, optional addressLine2, city, provinceOrState, postalOrZip and countryCode (two-letter). Example: {"firstName": "Jane", "lastName": "Doe", "addressLine1": "145 Mulberry St", "city": "New York", "provinceOrState": "NY", "postalOrZip": "10013", "countryCode": "US"}
descriptionstring- An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
inside_htmlstring- The HTML content for the inside of the self-mailer. You can supply _either_ this or insideTemplate but not both. Example: <p>Inside</p>
inside_templatestring- The template ID for the inside of the self-mailer. You can supply _either_ this or insideHTML but not both. Example: template_123456789abcdefghijklm
mailing_classstring- The mailing class of this order. If not provided, automatically set to first_class. Example: first_classone of
first_classstandard_classexpresscertifiedcertified_return_receiptregisteredusps_first_classusps_standard_classusps_eddmusps_express_2_dayusps_express_3_dayusps_first_class_certifiedusps_first_class_certified_return_receiptusps_first_class_registeredusps_express_3_day_signature_confirmationusps_express_3_day_certifiedusps_express_3_day_certified_return_receiptca_post_lettermailca_post_personalizedca_post_neighbourhood_mailups_express_overnightups_express_2_dayups_express_3_dayroyal_mail_first_classroyal_mail_second_classau_post_second_class merge_variablesobject- Values for the {{variables}} in the HTML or template, as a JSON object. Example: {"firstName": "Jane"}
metadataobject- Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
outside_htmlstring- The HTML content for the outside of the self-mailer. You can supply _either_ this or outsideTemplate but not both. Example: <p>Outside</p>
outside_templatestring- The template ID for the outside of the self-mailer. You can supply _either_ this or outsideHTML but not both. Example: template_223456789abcdefghijklm
paperstring- Premium paper selection used for this self-mailer. Available values include: - standard - premium_paper_self_mailer_standard_100lb Not all premium paper options are enabled for all organizations. If omitted, the organization default self-mailer paper is used when configured; otherwise standard. One of: standard, premium_paper_self_mailer_standard_100lb. Example: standardone of
standardpremium_paper_self_mailer_standard_100lb pdfstring- Public URL of a PDF to print. Give exactly one of html, template or pdf. Example: https://example.com/letter.pdf
send_datestring- Date the mail piece is sent to print, YYYY-MM-DD; defaults to now. Orders can be cancelled until then. Example: 2026-12-01
postgrid_template_createCreate a reusable HTML template with {{merge variables}} for letters, postcards and other mail.WriteCreate Template
Create a reusable HTML template with {{merge variables}} for letters, postcards and other mail. Returns object, html, id, description, metadata, live, createdAt, updatedAt. Use postgrid_template_update to change it.
Inputs
htmlstringrequired- HTML content of the letter. Give exactly one of html, template or pdf. Example: <html><body><p>Hello {{to.firstName}}</p></body></html>
descriptionstring- An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
metadataobject- Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
postgrid_template_updateUpdate a template's HTML, description or metadata.WriteUpdate Template
Update a template's HTML, description or metadata. Returns object, html, id, description, metadata, live, createdAt, updatedAt. Get template IDs from postgrid_templates_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: template_123456789abcdefghijklm
descriptionstring- An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
htmlstring- HTML content of the letter. Give exactly one of html, template or pdf. Example: <html><body><p>Hello {{to.firstName}}</p></body></html>
metadataobject- Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
postgrid_tracker_createCreate a QR-code/URL tracker whose redirect URL template can be used in mail to track visits.WriteCreate Tracker
Create a QR-code/URL tracker whose redirect URL template can be used in mail to track visits. Returns object, redirectURLTemplate, urlExpireAfterDays, visitCount, uniqueVisitCount, id, description, metadata, live, createdAt. Read visits with postgrid_tracker_get.
Inputs
redirect_url_templatestringrequired- The base template for URLs generated by this Tracker. Example: https://example.com/offer?contact={{to.id}}
url_expire_after_daysnumberrequired- The number of days generated Tracker URLs remain valid. One of: 30, 60, 90, 180, 365. Example: 90one of
306090180365 descriptionstring- An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
metadataobject- Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
postgrid_webhook_createCreate a webhook that receives the chosen event types at your URL.WriteCreate Webhook
Create a webhook that receives the chosen event types at your URL. Returns object, url, enabledEvents, payloadFormat, enabled, secret, id, description, metadata, live. Use postgrid_webhook_invocations_list to see deliveries.
Inputs
enabled_eventsarrayrequired- The list of event types this webhook listens for. Example: ["letter.created", "letter.updated"]
urlstringrequired- The trigger URL of the webhook. Must be HTTPS. Example: https://example.com/webhooks/postgrid
descriptionstring- An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
metadataobject- Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
payload_formatstring- The format in which the event payload is delivered. Defaults to jwt. One of: jwt, json. Example: jwtone of
jwtjson secretstring- The secret used to sign the payload of every event delivered to this webhook. You may supply your own secret on create or update; if omitted on create, one is generated for you. Example: whsec_4f9c2b7e1a8d6035bf12
postgrid_webhook_updateUpdate a webhook's URL, event types, payload format or enabled state.WriteUpdate Webhook
Update a webhook's URL, event types, payload format or enabled state. Returns object, url, enabledEvents, payloadFormat, enabled, secret, id, description, metadata, live. Get webhook IDs from postgrid_webhooks_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: webhook_123456789abcdefghijklm
descriptionstring- An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
enabledboolean- Whether this webhook is enabled. Disabled webhooks are not triggered. Example: true
enabled_eventsarray- The list of event types this webhook listens for. Example: ["letter.created", "letter.updated"]
metadataobject- Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
payload_formatstring- The format in which the event payload is delivered. Defaults to jwt. One of: jwt, json. Example: jwtone of
jwtjson secretstring- The secret used to sign the payload of every event delivered to this webhook. Example: whsec_4f9c2b7e1a8d6035bf12
urlstring- The trigger URL of the webhook. Must be HTTPS. Example: https://example.com/webhooks/postgrid
postgrid_bank_account_deleteDelete a bank account.DestructiveDelete Bank Account
Delete a bank account. Returns object, id, deleted. Get bank account IDs from postgrid_bank_accounts_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: bank_account_123456789abcdefghijklm
postgrid_campaign_deleteDelete a campaign.DestructiveDelete Campaign
Delete a campaign. Returns id, deleted. Get campaign IDs from postgrid_campaigns_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: campaign_123456789abcdefghijklm
postgrid_cheque_cancelCancel a cheque before it is sent to print.DestructiveCancel Cheque
Cancel a cheque before it is sent to print. Returns status, mergeVariables, trackingNumber, imbStatus, imbZIPCode, imbDate, cancellation, url, id, description. Only works before the send date. Get cheque IDs from postgrid_cheques_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: cheque_123456789abcdefghijklm
postgrid_cheque_cancel_with_noteCancel a cheque before it is printed and record the reason.DestructiveCancel Cheque with Note
Cancel a cheque before it is printed and record the reason. Returns status, mergeVariables, trackingNumber, imbStatus, imbZIPCode, imbDate, cancellation, url, id, description. Use postgrid_cheque_cancel to cancel without a note. Get cheque IDs from postgrid_cheques_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: cheque_123456789abcdefghijklm
notestringrequired- Note. Example: Address changed
postgrid_contact_deleteDelete a contact.DestructiveDelete Contact
Delete a contact. Returns object, id, deleted. Get contact IDs from postgrid_contacts_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: contact_123456789abcdefghijklm
postgrid_letter_cancelCancel a letter before it is sent to print.DestructiveCancel Letter
Cancel a letter before it is sent to print. Returns status, mergeVariables, trackingNumber, imbStatus, imbZIPCode, imbDate, cancellation, url, id, description. Only works before the send date. Get letter IDs from postgrid_letters_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: letter_123456789abcdefghijklm
postgrid_letter_cancel_with_noteCancel a letter before it is printed and record the reason.DestructiveCancel Letter with Note
Cancel a letter before it is printed and record the reason. Returns status, mergeVariables, trackingNumber, imbStatus, imbZIPCode, imbDate, cancellation, url, id, description. Use postgrid_letter_cancel to cancel without a note. Get letter IDs from postgrid_letters_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: letter_123456789abcdefghijklm
notestringrequired- Note. Example: Address changed
postgrid_mailing_list_deleteDelete a mailing list.DestructiveDelete Mailing List
Delete a mailing list. Returns id, deleted. Get mailing list IDs from postgrid_mailing_lists_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: mailing_list_123456789abcdefghijklm
postgrid_postcard_cancelCancel a postcard before it is sent to print.DestructiveCancel Postcard
Cancel a postcard before it is sent to print. Returns status, mergeVariables, trackingNumber, imbStatus, imbZIPCode, imbDate, cancellation, url, id, description. Only works before the send date. Get postcard IDs from postgrid_postcards_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: postcard_123456789abcdefghijklm
postgrid_postcard_cancel_with_noteCancel a postcard before it is printed and record the reason.DestructiveCancel Postcard with Note
Cancel a postcard before it is printed and record the reason. Returns status, mergeVariables, trackingNumber, imbStatus, imbZIPCode, imbDate, cancellation, url, id, description. Use postgrid_postcard_cancel to cancel without a note. Get postcard IDs from postgrid_postcards_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: postcard_123456789abcdefghijklm
notestringrequired- Note. Example: Address changed
postgrid_self_mailer_cancelCancel a self mailer before it is sent to print.DestructiveCancel Self Mailer
Cancel a self mailer before it is sent to print. Returns status, mergeVariables, trackingNumber, imbStatus, imbZIPCode, imbDate, cancellation, url, id, description. Only works before the send date. Get self mailer IDs from postgrid_self_mailers_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: self_mailer_123456789abcdefghijklm
postgrid_template_deleteDelete a template.DestructiveDelete Template
Delete a template. Returns object, id, deleted. Get template IDs from postgrid_templates_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: template_123456789abcdefghijklm
postgrid_webhook_deleteDelete a webhook.DestructiveDelete Webhook
Delete a webhook. Returns object, id, deleted. Get webhook IDs from postgrid_webhooks_list.
- Idempotent
Inputs
idstringrequired- ID of the record. Example: webhook_123456789abcdefghijklm
No tools match.