DocuPost ACTION
Mail Postcard
Dispatches a glossy, color 4x6 postcard via the US Postal Service. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's DocuPost account once, then configure and run Mail Postcard 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: "docupost-mail-postcard",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
docupost: { authProvisionId: "apn_xxxxxxx" },
frontImage: "Front Image URL",
backImage: "Back Image URL",
},
})
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": "docupost-mail-postcard",
"configured_props": {
"docupost": { "authProvisionId": "apn_xxxxxxx" },
"frontImage": "Front Image URL",
"backImage": "Back Image URL"
}
}'// 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": "docupost",
},
},
},
)
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: "docupost-mail-postcard",
arguments: {
frontImage: "Front Image URL",
backImage: "Back Image URL",
},
})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 |
|---|---|---|
frontImage Front Image URL | string | A valid image URL for the front of your postcard. Image should be 1875 x 1275. PNG recommended. Your API request will succeed but your mailing will later fail if the image is the incorrect size. Required |
backImage Back Image URL | string | A valid image URL for the back of your postcard. Image should be 1875 x 1275. PNG recommended. Your API request will succeed but your mailing will later fail if the image is the incorrect size. Important: Your recipient/sender and postage information will be automatically overlaid onto your image. See this template as an example. Required |
toName Recipient's Name | string | The name of the recipient (who the letter/postcard is being sent to). Must be less than 40 characters. Required |
toAddress1 Recipient's Address Line 1 | string | The first line of the recipient's address. Required |
toAddress2 Recipient's Address Line 2 | string | The second line of the recipient's address. Optional |
toCity Recipient's City | string | The city of the recipient. Required |
toState Recipient's State | string | The 2-letter abbreviation code for the recipient's U.S. state. Required |
toZip Recipient's Postal Code | string | The 5-digit postal code for the recipient. Required |
fromName Sender's Name | string | Your sender/return address name. Must be less than 40 characters. Required |
fromAddress1 Sender's Address Line 1 | string | The first line of your sender/return address. Required |
fromAddress2 Sender's Address Line 2 | string | The second line of your sender/return address. Optional |
fromCity Sender's City | string | The city of your sender/return address. Required |
fromState Sender's State | string | The 2-letter abbreviation code for your sender's U.S. state. Required |
fromZip Sender's Postal Code | string | The 5-digit postal code for your sender/return address. Required |
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
- docupost-mail-postcard
- Version
- 0.0.3
- App
- DocuPost
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗