View as Markdown
Lob icon

Lob ACTION

Cancel Postcard

Completely removes a postcard from production. This can only be done if the postcard has a send_date and the send_date has not yet passed. See docs here.
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Lob account once, then configure and run Cancel 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: "lob-cancel-postcard",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    lob: { authProvisionId: "apn_xxxxxxx" },
    postcardId: "Postcard",
  },
})

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.

Cancel Postcard inputs
Property Type Description
postcardId Postcard string
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
lob-cancel-postcard
Version
0.0.5
App
Lob
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes