View as Markdown
DocuPost icon

DocuPost ACTION

Mail Letter

Sends a physical letter via USPS first class mail. 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 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: "docupost-mail-letter",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    docupost: { authProvisionId: "apn_xxxxxxx" },
    pdf: "PDF URL",
    color: true,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Mail Letter inputs
Property Type Description
pdf PDF URL string
A valid PDF URL for the letter content. 10mb max. 8.5x11 recommended.
Required
color Color boolean
Whether the document should be in color. true or false. Defaults to false.
Optional
doublesided Double-Sided string
Whether the document should be printed double-sided. true or false. Defaults to true.
Optional
mailingClass Class string
Must be usps_first_class or usps_standard. Defaults to usps_first_class.
Optional
servicelevel Service Level string
Only available for usps_first_class mailings. Should be blank for non-certified, or certified or certified_return_receipt.
Optional
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-letter
Version
0.0.3
App
DocuPost
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes