View as Markdown
Postalytics icon

Postalytics ACTION

Send and Track Postcard or Letter

Send a postcard or letter with the capability of tracking delivery and response. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Postalytics account once, then configure and run Send and Track Postcard or 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: "postalytics-send-track-postcard-letter",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    postalytics: { authProvisionId: "apn_xxxxxxx" },
    firstName: "First Name",
    lastName: "Last Name",
  },
})

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.

Send and Track Postcard or Letter inputs
Property Type Description
firstName First Name string
Recipient's first name must be between 1 and 50 characters long.
Required
lastName Last Name string
Recipient's last name must be between 1 and 50 characters long.
Required
company Company string
If provided, can be up to 100 characters long.
Optional
phone Phone string
If provided, can be up to 100 characters long.
Optional
addressStreet Address Street string
Recipient's street, can be up to 100 characters long.
Required
addressStreet2 Address Street 2 string
Recipient's street2, can be up to 100 characters long.
Required
addressCity Address City string
Recipient's address, can be up to 100 characters long.
Required
addressState Address State string
Recipient's state, must be a 2 letter state short-name code or a valid full state name.
Required
addressZip Address Zip string
Recipient's zip code, must be in valid zip format.
Required
emailAddress Email Address string
Recipient's email address up to 100 characters long
Optional
varField1 Var Field 1 string
Any string up to 255 characters
Optional
varField2 Var Field 2 string
Any string up to 255 characters
Optional
varField3 Var Field 3 string
Any string up to 255 characters
Optional
varField4 Var Field 4 string
Any string up to 255 characters
Optional
varField5 Var Field 5 string
Any string up to 255 characters
Optional
varField6 Var Field 6 string
Any string up to 255 characters
Optional
varField7 Var Field 7 string
Any string up to 255 characters
Optional
varField8 Var Field 8 string
Any string up to 255 characters
Optional
varField9 Var Field 9 string
Any string up to 255 characters
Optional
varField10 Var Field 10 string
Any string up to 255 characters
Optional
campaignId Campaign ID string
The unique identifier for a campaign
Required Dynamic

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
postalytics-send-track-postcard-letter
Version
0.0.2
App
Postalytics
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes