PostGrid Print & Mail ACTION
Create Letter
Creates a new letter in PostGrid. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's PostGrid Print & Mail account once, then configure and run Create Letter from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "postgrid-create-letter",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
postgrid: { authProvisionId: "apn_xxxxxxx" },
to: "To",
from: "From",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "postgrid-create-letter",
"configured_props": {
"postgrid": { "authProvisionId": "apn_xxxxxxx" },
"to": "To",
"from": "From"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "postgrid",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "postgrid-create-letter",
arguments: {
to: "To",
from: "From",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
to To | string | The id or contact object of the receiver. Required Dynamic |
from From | string | The id or contact object of the sender. Required Dynamic |
html HTML | string | The HTML content of the letter. Required |
addressPlacement Address Placement | string | The location where the address will be placed. Optional |
doubleSided Double Sided | boolean | Indicates if the letter is double sided or not. Optional |
color Color | boolean | Indicates whether the letter will be printed in color or not. Optional |
perforatedPage Perforated Page | integer | Indicates if the page is to be perforated (holes). Optional |
extraService Extra Service | string | Indicates extra services for the letter. Optional |
envelopeType Envelope Type | string | Indicates the envelope type for the letter. Optional |
returnEnvelope Return Envelope | string | The id of the return envelope to be used. Optional Dynamic |
sendDate Send Date | string | The desired date for the letter to be sent out. Example: 2023-02-16T15:40:35.873Z Optional |
description Description | string | A description for the letter. Optional |
express Express | boolean | See express shipping. Optional |
mailingClass Mailing Class | string | Defaults to first_class. See mailing class. Optional |
size Size | string | Default size will be chosen based on the destination country, if not provided. Indicates the letter size for the letter being created. Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- postgrid-create-letter
- Version
- 0.0.2
- App
- PostGrid Print & Mail
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗