View as Markdown
PostGrid Print & Mail icon

PostGrid Print & Mail ACTION

Create Postcard

Creates a new postcard 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 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: "postgrid-create-postcard",
  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)

SCHEMA

Inputs

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

Create Postcard inputs
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
frontHTML Front HTML string
The HTML content for the front of the postcard.
Required
backHTML Back HTML string
The HTML content for the back of the postcard.
Required
size Size string
The size of the postcard. Must be one of either 6x4, 9x6 or 11x6.
Required
sendDate Send Date string
The desired date for the letter to be sent out. Example: 2023-02-16T15:40:35.873Z
Optional
express Express boolean
Express shipping.
Optional
description Description string
A description for the postcard.
Optional
mailingClass Mailing Class string
Mailing class. Defaults to first_class.
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-postcard
Version
0.0.3
App
PostGrid Print & Mail
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes