> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to PostGrid Print & Mail

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.

**Authentication:** API Key
**Categories:** Automation, Marketing
**Tools:** 60: 30 read, 17 write, 13 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=POSTGRID)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the PostGrid Print & Mail connection

   In **AgentKit > Connections**, create a PostGrid Print & Mail connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   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.actions

   const connector = 'postgrid'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { 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 call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'postgrid_bank_accounts_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_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.actions

   connection_name = "postgrid"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_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 call
   result = actions.execute_tool(
       tool_input={},
       tool_name="postgrid_bank_accounts_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their PostGrid Print & Mail credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'postgrid_bank_account_get',
  toolInput: {
    id: '<id>',
  },
  connector: 'postgrid',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="postgrid_bank_account_get",
    tool_input={
        "id": "<id>",
    },
    connection_name="postgrid",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `postgrid_bank_account_get`

Get Bank Account · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: bank_account_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_bank_accounts_list`

List Bank Accounts · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 10
- `search` (`string`, optional): Free-text search over the records. Example: Jane
- `skip` (`integer`, optional): Number of records to skip, for paging. Example: 0

Example input: `{}`

### `postgrid_campaign_get`

Get Campaign · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: campaign_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_campaigns_list`

List Campaigns · Read-only

List campaigns, newest first, with search and skip/limit paging.
Returns object, totalCount, skip, limit, data.
Use postgrid_campaign_get for one campaign.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 10
- `search` (`string`, optional): Free-text search over the records. Example: Jane
- `skip` (`integer`, optional): Number of records to skip, for paging. Example: 0

Example input: `{}`

### `postgrid_cheque_get`

Get Cheque · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: cheque_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_cheque_preview_get`

Get Cheque Preview · Read-only

Get a temporary URL to the rendered PDF preview of a cheque.
Returns id, object, url.
Get cheque IDs from postgrid_cheques_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: cheque_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_cheques_list`

List Cheques · Read-only

List cheques, newest first, with search and skip/limit paging.
Returns object, totalCount, skip, limit, data.
Use postgrid_cheque_get for one cheque.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 10
- `search` (`string`, optional): Free-text search over the records. Example: Jane
- `skip` (`integer`, optional): Number of records to skip, for paging. Example: 0

Example input: `{}`

### `postgrid_contact_get`

Get Contact · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: contact_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_contacts_list`

List Contacts · Read-only

List contacts, newest first, with search and skip/limit paging.
Returns object, totalCount, skip, limit, data.
Use postgrid_contact_get for one contact.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 10
- `search` (`string`, optional): Free-text search over the records. Example: Jane
- `skip` (`integer`, optional): Number of records to skip, for paging. Example: 0

Example input: `{}`

### `postgrid_events_list`

List Events · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 10
- `skip` (`integer`, optional): Number of records to skip, for paging. Example: 0
- `type` (`array`, optional): An optional list of event types to filter the results by. Example: letter.created

Example input: `{}`

### `postgrid_letter_get`

Get Letter · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: letter_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_letter_preview_get`

Get Letter Preview · Read-only

Get a temporary URL to the rendered PDF preview of a letter.
Returns id, object, url.
Get letter IDs from postgrid_letters_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: letter_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_letters_list`

List Letters · Read-only

List letters, newest first, with search and skip/limit paging.
Returns object, totalCount, skip, limit, data.
Use postgrid_letter_get for one letter.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 10
- `search` (`string`, optional): Free-text search over the records. Example: Jane
- `skip` (`integer`, optional): Number of records to skip, for paging. Example: 0

Example input: `{}`

### `postgrid_mailing_list_get`

Get Mailing List · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: mailing_list_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_mailing_list_import_get`

Get Mailing List Import · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: mailing_list_import_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_mailing_list_imports_list`

List Mailing List Imports · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 10
- `search` (`string`, optional): Free-text search over the records. Example: Jane
- `skip` (`integer`, optional): Number of records to skip, for paging. Example: 0

Example input: `{}`

### `postgrid_mailing_lists_list`

List Mailing Lists · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 10
- `search` (`string`, optional): Free-text search over the records. Example: Jane
- `skip` (`integer`, optional): Number of records to skip, for paging. Example: 0

Example input: `{}`

### `postgrid_postcard_get`

Get Postcard · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: postcard_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_postcard_preview_get`

Get Postcard Preview · Read-only

Get a temporary URL to the rendered PDF preview of a postcard.
Returns id, object, url.
Get postcard IDs from postgrid_postcards_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: postcard_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_postcards_list`

List Postcards · Read-only

List postcards, newest first, with search and skip/limit paging.
Returns object, totalCount, skip, limit, data.
Use postgrid_postcard_get for one postcard.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 10
- `search` (`string`, optional): Free-text search over the records. Example: Jane
- `skip` (`integer`, optional): Number of records to skip, for paging. Example: 0

Example input: `{}`

### `postgrid_self_mailer_get`

Get Self Mailer · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: self_mailer_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_self_mailer_preview_get`

Get Self Mailer Preview · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: self_mailer_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_self_mailers_list`

List Self Mailers · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 10
- `search` (`string`, optional): Free-text search over the records. Example: Jane
- `skip` (`integer`, optional): Number of records to skip, for paging. Example: 0

Example input: `{}`

### `postgrid_template_get`

Get Template · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: template_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_templates_list`

List Templates · Read-only

List templates, newest first, with search and skip/limit paging.
Returns object, totalCount, skip, limit, data.
Use postgrid_template_get for one template.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 10
- `search` (`string`, optional): Free-text search over the records. Example: Jane
- `skip` (`integer`, optional): Number of records to skip, for paging. Example: 0

Example input: `{}`

### `postgrid_tracker_get`

Get Tracker · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: tracker_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_trackers_list`

List Trackers · Read-only

List trackers, newest first, with search and skip/limit paging.
Returns object, totalCount, skip, limit, data.
Use postgrid_tracker_get for one tracker.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 10
- `search` (`string`, optional): Free-text search over the records. Example: Jane
- `skip` (`integer`, optional): Number of records to skip, for paging. Example: 0

Example input: `{}`

### `postgrid_webhook_get`

Get Webhook · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: webhook_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_webhook_invocations_list`

List Webhook Invocations · Read-only

List the delivery attempts of a webhook with their status codes.
Returns object, totalCount, skip, limit, data.
Get webhook IDs from postgrid_webhooks_list.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: webhook_123456789abcdefghijklm
- `limit` (`integer`, optional): Maximum number of records to return. Example: 10
- `search` (`string`, optional): Free-text search over the records. Example: Jane
- `skip` (`integer`, optional): Number of records to skip, for paging. Example: 0

Example input: `{"id":"<id>"}`

### `postgrid_webhooks_list`

List Webhooks · Read-only

List webhooks, newest first, with search and skip/limit paging.
Returns object, totalCount, skip, limit, data.
Use postgrid_webhook_get for one webhook.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `limit` (`integer`, optional): Maximum number of records to return. Example: 10
- `search` (`string`, optional): Free-text search over the records. Example: Jane
- `skip` (`integer`, optional): Number of records to skip, for paging. Example: 0

Example input: `{}`

### `postgrid_bank_account_create`

Create Bank Account · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `account_number` (`string`, required): The account number of the bank account. Example: 000123456789
- `bank_country_code` (`string`, required): The country code of the bank. One of: CA, US. Example: US. One of: `CA`, `US`.
- `bank_name` (`string`, required): The name of the bank. Example: Example Bank
- `signature_text` (`string`, required): The signature text of the bank account. Example: Jane Doe
- `bank_primary_line` (`string`, optional): The primary address line of the bank. Example: 100 Bank St
- `bank_secondary_line` (`string`, optional): The secondary address line of the bank. Example: New York, NY 10001
- `ca_designation_number` (`string`, optional): The designation number of the bank account (for CA). Example: example
- `description` (`string`, optional): An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
- `metadata` (`object`, optional): Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
- `route_number` (`string`, optional): The route number of the bank account (for CA). Example: example
- `routing_number` (`string`, optional): The routing number of the bank account (for US). Example: 011000015
- `transit_number` (`string`, optional): The transit number of the bank account (for CA). Example: example

Example input: `{"account_number":"<account_number>","bank_country_code":"CA","bank_name":"<bank_name>","signature_text":"<signature_text>"}`

### `postgrid_campaign_create`

Create Campaign · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `mailing_list` (`string`, required): The ID of the mailing list associated with this campaign. Example: mailing_list_123456789abcdefghijklm
- `cheque` (`object`, optional): Inline cheque configuration for this campaign. Only one collateral type can be set. Example: {"key": "value"}
- `default_sender_contact` (`string`, optional): The ID of the default sender contact to use for orders if not specified per recipient. Example: contact_123456789abcdefghijklm
- `description` (`string`, optional): An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
- `letter` (`object`, optional): Inline letter configuration for this campaign. Only one collateral type can be set. Example: {"template": "template_123456789abcdefghijklm"}
- `metadata` (`object`, optional): Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
- `postcard` (`object`, optional): Inline postcard configuration for this campaign. Only one collateral type can be set. Example: {"key": "value"}
- `self_mailer` (`object`, optional): Inline self-mailer configuration for this campaign. Only one collateral type can be set. Example: {"key": "value"}
- `send_date` (`string`, optional): Date the mail piece is sent to print, YYYY-MM-DD; defaults to now. Orders can be cancelled until then. Example: 2026-12-01

Example input: `{"mailing_list":"<mailing_list>"}`

### `postgrid_campaign_send`

Send Campaign · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): ID of the record. Example: campaign_123456789abcdefghijklm
- `send_date` (`string`, optional): Date the mail piece is sent to print, YYYY-MM-DD; defaults to now. Orders can be cancelled until then. Example: 2026-12-01

Example input: `{"id":"<id>"}`

### `postgrid_campaign_update`

Update Campaign · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: campaign_123456789abcdefghijklm
- `cheque` (`object`, optional): Inline cheque configuration. Setting this will remove other collateral types. Set to null to remove. Example: {"key": "value"}
- `default_sender_contact` (`string`, optional): The ID of the default sender contact. Set to null to remove. Example: contact_123456789abcdefghijklm
- `description` (`string`, optional): An optional description for the campaign. Set to null to remove the existing description. Example: Welcome letter batch
- `letter` (`object`, optional): Inline letter configuration. Setting this will remove other collateral types. Set to null to remove. Example: {"template": "template_123456789abcdefghijklm"}
- `mailing_list` (`string`, optional): The ID of the mailing list to associate with this campaign. Example: mailing_list_123456789abcdefghijklm
- `metadata` (`object`, optional): Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
- `postcard` (`object`, optional): Inline postcard configuration. Setting this will remove other collateral types. Set to null to remove. Example: {"key": "value"}
- `self_mailer` (`object`, optional): Inline self-mailer configuration. Setting this will remove other collateral types. Set to null to remove. Example: {"key": "value"}

Example input: `{"id":"<id>"}`

### `postgrid_cheque_create`

Create Cheque · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `amount` (`integer`, required): Cheque amount in cents (10000 = 100.00). Example: 10000
- `bank_account` (`string`, required): The bank account (ID) associated with the cheque. Example: bank_123456789abcdefghijklm
- `to` (`object`, required): 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"}
- `description` (`string`, optional): An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
- `from` (`object`, optional): 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_html` (`string`, optional): 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_template` (`string`, optional): A Template ID for the letter attached to the cheque, if any. Example: example
- `mailing_class` (`string`, optional): The mailing class of this order. If not provided, automatically set to first_class. Example: first_class. One of: `first_class`, `standard_class`, `express`, `certified`, `certified_return_receipt`, `registered`, `usps_first_class`, `usps_standard_class`, `usps_eddm`, `usps_express_2_day`, `usps_express_3_day`, `usps_first_class_certified`, `usps_first_class_certified_return_receipt`, `usps_first_class_registered`, `usps_express_3_day_signature_confirmation`, `usps_express_3_day_certified`, `usps_express_3_day_certified_return_receipt`, `ca_post_lettermail`, `ca_post_personalized`, `ca_post_neighbourhood_mail`, `ups_express_overnight`, `ups_express_2_day`, `ups_express_3_day`, `royal_mail_first_class`, `royal_mail_second_class`, `au_post_second_class`.
- `memo` (`string`, optional): The memo of the cheque. Example: Invoice 1042
- `merge_variables` (`object`, optional): Values for the {{variables}} in the HTML or template, as a JSON object. Example: {"firstName": "Jane"}
- `message` (`string`, optional): The message of the cheque. Example: Thank you for your business.
- `metadata` (`object`, optional): Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
- `number` (`integer`, optional): 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_date` (`string`, optional): Date the mail piece is sent to print, YYYY-MM-DD; defaults to now. Orders can be cancelled until then. Example: 2026-12-01

Example input: `{"amount":10000,"bank_account":"<bank_account>","to":{"firstName":"Jane","lastName":"Doe","addressLine1":"145 Mulberry St","city":"New York","provinceOrState":"NY","postalOrZip":"10013","countryCode":"US"}}`

### `postgrid_contact_create`

Create Contact · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `address_line1` (`string`, required): The first line of the contact's address. Example: 145 Mulberry St
- `country_code` (`string`, required): The ISO 3611-1 country code of the contact's address. If omitted, your organization's default country code is used. Example: US
- `address_line2` (`string`, optional): Second line of the contact's address, if applicable. Example: Suite 4
- `city` (`string`, optional): The city of the contact's address. Example: New York
- `company_name` (`string`, optional): Company Name. Example: Acme Inc
- `description` (`string`, optional): An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
- `email` (`string`, optional): Email of the contact. Example: jane@example.com
- `first_name` (`string`, optional): First name of the contact. Example: Jane
- `force_verified_status` (`boolean`, optional): If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise. Example: false
- `job_title` (`string`, optional): Job title of the contact. Example: Office Manager
- `last_name` (`string`, optional): Last name of the contact. Example: Doe
- `metadata` (`object`, optional): Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
- `phone_number` (`string`, optional): Phone number of the contact. Example: +15555550100
- `postal_or_zip` (`string`, optional): The postal or ZIP code of the contact's address. Example: 10013
- `province_or_state` (`string`, optional): Province or state of the contact's address. Example: NY
- `secret` (`boolean`, optional): 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_verification` (`boolean`, optional): If true, PostGrid will skip running this contact's address through our address verification system. Example: false

Example input: `{"address_line1":"<address_line1>","country_code":"<country_code>"}`

### `postgrid_letter_create`

Create Letter · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from` (`object`, required): 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"}
- `to` (`object`, required): 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_placement` (`string`, optional): The placement of the address on the letter. One of: top_first_page, insert_blank_page. Example: top_first_page. One of: `top_first_page`, `insert_blank_page`.
- `color` (`boolean`, optional): Indicates if the letter is in color. Example: false
- `description` (`string`, optional): An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
- `double_sided` (`boolean`, optional): Indicates if the letter is double-sided. Example: false
- `envelope` (`string`, optional): The envelope (ID) for the letter. You can either specify a custom envelope ID or use the default standard envelope. Example: standard
- `html` (`string`, optional): HTML content of the letter. Give exactly one of html, template or pdf. Example: <html><body>Hello {{to.firstName}}
</body></html>
- `mailing_class` (`string`, optional): The mailing class of this order. If not provided, automatically set to first_class. Example: first_class. One of: `first_class`, `standard_class`, `express`, `certified`, `certified_return_receipt`, `registered`, `usps_first_class`, `usps_standard_class`, `usps_eddm`, `usps_express_2_day`, `usps_express_3_day`, `usps_first_class_certified`, `usps_first_class_certified_return_receipt`, `usps_first_class_registered`, `usps_express_3_day_signature_confirmation`, `usps_express_3_day_certified`, `usps_express_3_day_certified_return_receipt`, `ca_post_lettermail`, `ca_post_personalized`, `ca_post_neighbourhood_mail`, `ups_express_overnight`, `ups_express_2_day`, `ups_express_3_day`, `royal_mail_first_class`, `royal_mail_second_class`, `au_post_second_class`.
- `merge_variables` (`object`, optional): Values for the {{variables}} in the HTML or template, as a JSON object. Example: {"firstName": "Jane"}
- `metadata` (`object`, optional): Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
- `paper` (`string`, optional): 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: standard. One of: `standard`, `premium_paper_letter_standard_white_70lb`, `premium_paper_letter_standard_white_80lb`.
- `pdf` (`string`, optional): Public URL of a PDF to print. Give exactly one of html, template or pdf. Example: https://example.com/letter.pdf
- `send_date` (`string`, optional): Date the mail piece is sent to print, YYYY-MM-DD; defaults to now. Orders can be cancelled until then. Example: 2026-12-01
- `size` (`string`, optional): The size of the letter. One of: us_letter, a4. Example: us_letter. One of: `us_letter`, `a4`.
- `template` (`string`, optional): ID of a saved template (from postgrid_templates_list). Give exactly one of html, template or pdf. Example: template_123456789abcdefghijklm

Example input: `{"from":{"companyName":"Acme Inc","addressLine1":"20 Bay St","city":"Toronto","provinceOrState":"ON","postalOrZip":"M5J 2N8","countryCode":"CA"},"to":{"firstName":"Jane","lastName":"Doe","addressLine1":"145 Mulberry St","city":"New York","provinceOrState":"NY","postalOrZip":"10013","countryCode":"US"}}`

### `postgrid_mailing_list_create`

Create Mailing List · Write

Create an empty mailing list.
Returns id, description, metadata, live, createdAt, updatedAt, status, errors.
Add contacts with postgrid_mailing_list_job_submit.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `description` (`string`, optional): An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
- `metadata` (`object`, optional): Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}

Example input: `{}`

### `postgrid_mailing_list_job_submit`

Update Mailing List Contacts · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `id` (`string`, required): ID of the record. Example: mailing_list_123456789abcdefghijklm
- `add_contacts` (`array`, optional): List of contact IDs to add to the mailing list. Cannot be used with other operations. Example: ["contact_123456789abcdefghijklm"]
- `add_mailing_list_imports` (`array`, optional): List of mailing list import IDs to add to the mailing list. Cannot be used with other operations. Example: ["value"]
- `remove_contacts` (`array`, optional): List of contact IDs to remove from the mailing list. Cannot be used with other operations. Example: ["contact_223456789abcdefghijklm"]
- `remove_mailing_list_imports` (`array`, optional): List of mailing list import IDs to remove from the mailing list. Cannot be used with other operations. Example: ["value"]

Example input: `{"id":"<id>"}`

### `postgrid_mailing_list_update`

Update Mailing List · Write

Update a mailing list's description or metadata.
Returns description, metadata.
Get mailing list IDs from postgrid_mailing_lists_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: mailing_list_123456789abcdefghijklm
- `description` (`string`, optional): An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
- `metadata` (`object`, optional): Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}

Example input: `{"id":"<id>"}`

### `postgrid_postcard_create`

Create Postcard · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from` (`object`, required): 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"}
- `size` (`string`, required): The size of the postcard. One of: 6x4, 9x6, 11x6. Example: 6x4. One of: `6x4`, `9x6`, `11x6`.
- `to` (`object`, required): 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_html` (`string`, optional): The HTML content for the back of the postcard. You can supply _either_ this or backTemplate but not both. Example: Back

- `back_template` (`string`, optional): The template ID for the back of the postcard. You can supply _either_ this or backHTML but not both. Example: template_223456789abcdefghijklm
- `description` (`string`, optional): An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
- `front_html` (`string`, optional): The HTML content for the front of the postcard. You can supply _either_ this or frontTemplate but not both. Example: Front

- `front_template` (`string`, optional): The template ID for the front of the postcard. You can supply _either_ this or frontHTML but not both. Example: template_123456789abcdefghijklm
- `mailing_class` (`string`, optional): The mailing class of this order. If not provided, automatically set to first_class. Example: first_class. One of: `first_class`, `standard_class`, `express`, `certified`, `certified_return_receipt`, `registered`, `usps_first_class`, `usps_standard_class`, `usps_eddm`, `usps_express_2_day`, `usps_express_3_day`, `usps_first_class_certified`, `usps_first_class_certified_return_receipt`, `usps_first_class_registered`, `usps_express_3_day_signature_confirmation`, `usps_express_3_day_certified`, `usps_express_3_day_certified_return_receipt`, `ca_post_lettermail`, `ca_post_personalized`, `ca_post_neighbourhood_mail`, `ups_express_overnight`, `ups_express_2_day`, `ups_express_3_day`, `royal_mail_first_class`, `royal_mail_second_class`, `au_post_second_class`.
- `merge_variables` (`object`, optional): Values for the {{variables}} in the HTML or template, as a JSON object. Example: {"firstName": "Jane"}
- `metadata` (`object`, optional): Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
- `paper` (`string`, optional): 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: 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`.
- `pdf` (`string`, optional): Public URL of a PDF to print. Give exactly one of html, template or pdf. Example: https://example.com/letter.pdf
- `send_date` (`string`, optional): Date the mail piece is sent to print, YYYY-MM-DD; defaults to now. Orders can be cancelled until then. Example: 2026-12-01

Example input: `{"from":{"companyName":"Acme Inc","addressLine1":"20 Bay St","city":"Toronto","provinceOrState":"ON","postalOrZip":"M5J 2N8","countryCode":"CA"},"size":"6x4","to":{"firstName":"Jane","lastName":"Doe","addressLine1":"145 Mulberry St","city":"New York","provinceOrState":"NY","postalOrZip":"10013","countryCode":"US"}}`

### `postgrid_self_mailer_create`

Create Self Mailer · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from` (`object`, required): 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"}
- `size` (`string`, required): The size of the self-mailer. One of: 8.5x11_bifold, 8.5x11_trifold, 9.5x16_trifold. Example: 8.5x11_bifold. One of: `8.5x11_bifold`, `8.5x11_trifold`, `9.5x16_trifold`.
- `to` (`object`, required): 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"}
- `description` (`string`, optional): An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
- `inside_html` (`string`, optional): The HTML content for the inside of the self-mailer. You can supply _either_ this or insideTemplate but not both. Example: Inside

- `inside_template` (`string`, optional): The template ID for the inside of the self-mailer. You can supply _either_ this or insideHTML but not both. Example: template_123456789abcdefghijklm
- `mailing_class` (`string`, optional): The mailing class of this order. If not provided, automatically set to first_class. Example: first_class. One of: `first_class`, `standard_class`, `express`, `certified`, `certified_return_receipt`, `registered`, `usps_first_class`, `usps_standard_class`, `usps_eddm`, `usps_express_2_day`, `usps_express_3_day`, `usps_first_class_certified`, `usps_first_class_certified_return_receipt`, `usps_first_class_registered`, `usps_express_3_day_signature_confirmation`, `usps_express_3_day_certified`, `usps_express_3_day_certified_return_receipt`, `ca_post_lettermail`, `ca_post_personalized`, `ca_post_neighbourhood_mail`, `ups_express_overnight`, `ups_express_2_day`, `ups_express_3_day`, `royal_mail_first_class`, `royal_mail_second_class`, `au_post_second_class`.
- `merge_variables` (`object`, optional): Values for the {{variables}} in the HTML or template, as a JSON object. Example: {"firstName": "Jane"}
- `metadata` (`object`, optional): Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
- `outside_html` (`string`, optional): The HTML content for the outside of the self-mailer. You can supply _either_ this or outsideTemplate but not both. Example: Outside

- `outside_template` (`string`, optional): The template ID for the outside of the self-mailer. You can supply _either_ this or outsideHTML but not both. Example: template_223456789abcdefghijklm
- `paper` (`string`, optional): 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: standard. One of: `standard`, `premium_paper_self_mailer_standard_100lb`.
- `pdf` (`string`, optional): Public URL of a PDF to print. Give exactly one of html, template or pdf. Example: https://example.com/letter.pdf
- `send_date` (`string`, optional): Date the mail piece is sent to print, YYYY-MM-DD; defaults to now. Orders can be cancelled until then. Example: 2026-12-01

Example input: `{"from":{"companyName":"Acme Inc","addressLine1":"20 Bay St","city":"Toronto","provinceOrState":"ON","postalOrZip":"M5J 2N8","countryCode":"CA"},"size":"8.5x11_bifold","to":{"firstName":"Jane","lastName":"Doe","addressLine1":"145 Mulberry St","city":"New York","provinceOrState":"NY","postalOrZip":"10013","countryCode":"US"}}`

### `postgrid_template_create`

Create Template · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `html` (`string`, required): HTML content of the letter. Give exactly one of html, template or pdf. Example: <html><body>Hello {{to.firstName}}
</body></html>
- `description` (`string`, optional): An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
- `metadata` (`object`, optional): Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}

Example input: `{"html":"<html>"}`

### `postgrid_template_update`

Update Template · Write

Update a template's HTML, description or metadata.
Returns object, html, id, description, metadata, live, createdAt, updatedAt.
Get template IDs from postgrid_templates_list.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: template_123456789abcdefghijklm
- `description` (`string`, optional): An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
- `html` (`string`, optional): HTML content of the letter. Give exactly one of html, template or pdf. Example: <html><body>Hello {{to.firstName}}
</body></html>
- `metadata` (`object`, optional): Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}

Example input: `{"id":"<id>"}`

### `postgrid_tracker_create`

Create Tracker · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `redirect_url_template` (`string`, required): The base template for URLs generated by this Tracker. Example: https://example.com/offer?contact={{to.id}}
- `url_expire_after_days` (`number`, required): The number of days generated Tracker URLs remain valid. One of: 30, 60, 90, 180, 365. Example: 90. One of: `30`, `60`, `90`, `180`, `365`.
- `description` (`string`, optional): An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
- `metadata` (`object`, optional): Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}

Example input: `{"redirect_url_template":"<redirect_url_template>","url_expire_after_days":90}`

### `postgrid_webhook_create`

Create Webhook · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `enabled_events` (`array`, required): The list of event types this webhook listens for. Example: ["letter.created", "letter.updated"]
- `url` (`string`, required): The trigger URL of the webhook. Must be HTTPS. Example: https://example.com/webhooks/postgrid
- `description` (`string`, optional): An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
- `metadata` (`object`, optional): Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
- `payload_format` (`string`, optional): The format in which the event payload is delivered. Defaults to jwt. One of: jwt, json. Example: jwt. One of: `jwt`, `json`.
- `secret` (`string`, optional): 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

Example input: `{"enabled_events":["letter.created","letter.updated"],"url":"<url>"}`

### `postgrid_webhook_update`

Update Webhook · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: webhook_123456789abcdefghijklm
- `description` (`string`, optional): An optional string describing this resource. Will be visible in the API and the dashboard. Example: Welcome letter batch
- `enabled` (`boolean`, optional): Whether this webhook is enabled. Disabled webhooks are not triggered. Example: true
- `enabled_events` (`array`, optional): The list of event types this webhook listens for. Example: ["letter.created", "letter.updated"]
- `metadata` (`object`, optional): Your own key-value data stored on the record, as a JSON object. Example: {"customerId": "cus_123"}
- `payload_format` (`string`, optional): The format in which the event payload is delivered. Defaults to jwt. One of: jwt, json. Example: jwt. One of: `jwt`, `json`.
- `secret` (`string`, optional): The secret used to sign the payload of every event delivered to this webhook. Example: whsec_4f9c2b7e1a8d6035bf12
- `url` (`string`, optional): The trigger URL of the webhook. Must be HTTPS. Example: https://example.com/webhooks/postgrid

Example input: `{"id":"<id>"}`

### `postgrid_bank_account_delete`

Delete Bank Account · Destructive

Delete a bank account.
Returns object, id, deleted.
Get bank account IDs from postgrid_bank_accounts_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: bank_account_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_campaign_delete`

Delete Campaign · Destructive

Delete a campaign.
Returns id, deleted.
Get campaign IDs from postgrid_campaigns_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: campaign_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_cheque_cancel`

Cancel Cheque · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: cheque_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_cheque_cancel_with_note`

Cancel Cheque with Note · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: cheque_123456789abcdefghijklm
- `note` (`string`, required): Note. Example: Address changed

Example input: `{"id":"<id>","note":"<note>"}`

### `postgrid_contact_delete`

Delete Contact · Destructive

Delete a contact.
Returns object, id, deleted.
Get contact IDs from postgrid_contacts_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: contact_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_letter_cancel`

Cancel Letter · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: letter_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_letter_cancel_with_note`

Cancel Letter with Note · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: letter_123456789abcdefghijklm
- `note` (`string`, required): Note. Example: Address changed

Example input: `{"id":"<id>","note":"<note>"}`

### `postgrid_mailing_list_delete`

Delete Mailing List · Destructive

Delete a mailing list.
Returns id, deleted.
Get mailing list IDs from postgrid_mailing_lists_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: mailing_list_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_postcard_cancel`

Cancel Postcard · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: postcard_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_postcard_cancel_with_note`

Cancel Postcard with Note · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: postcard_123456789abcdefghijklm
- `note` (`string`, required): Note. Example: Address changed

Example input: `{"id":"<id>","note":"<note>"}`

### `postgrid_self_mailer_cancel`

Cancel Self Mailer · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: self_mailer_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_template_delete`

Delete Template · Destructive

Delete a template.
Returns object, id, deleted.
Get template IDs from postgrid_templates_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: template_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

### `postgrid_webhook_delete`

Delete Webhook · Destructive

Delete a webhook.
Returns object, id, deleted.
Get webhook IDs from postgrid_webhooks_list.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `id` (`string`, required): ID of the record. Example: webhook_123456789abcdefghijklm

Example input: `{"id":"<id>"}`

## Related

Other Automation connectors ([all 91](/agentkit/connectors/?category=automation)):

- [Mailchimp](/agentkit/connectors/mailchimp/): Scalekit connector, OAuth, 73 tools
- [Twilio](/agentkit/connectors/twilio/): Scalekit connector, Username and password, 61 tools
- [Stripe](/agentkit/connectors/stripe/): Scalekit connector, Access token, 178 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
