View as Markdown
OnlineCheckWriter icon

OnlineCheckWriter ACTION

Create Mail Check

Creates a mail check. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's OnlineCheckWriter account once, then configure and run Create Mail Check 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: "onlinecheckwriter-create-mail-check",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    onlinecheckwriter: { authProvisionId: "apn_xxxxxxx" },
    isShippingToCustomAddress: true,
    customFromAddressId: "Custom From Address ID",
  },
})

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 Mail Check inputs
Property Type Description
isShippingToCustomAddress Shipping To Custom Address? boolean
Value is true if sending mail to custom address. Default false
Optional
customFromAddressId Custom From Address ID string
Must be a custom from address ID. Required if Shipping To Custom Address? is true.
Optional Dynamic
customToAddressId Custom To Address ID string
Must be a custom to address ID. Required if Shipping To Custom Address? is true.
Optional Dynamic
customShippingTypeId Custom Shipping Type ID string
Must be a valid custom shipping type ID. Required if Shipping To Custom Address? is true.
Optional
checkId Check ID string
Must be a check ID.
Required Dynamic
shippingTypeId Shipping Type ID string
The shipping type ID of the check.
Required
paperTypeId Paper Type ID string
Must be a valid paper type ID.
Required
informTypeId Inform Type ID string
Must be a valid inform type ID.
Optional
enableSmsInform Enable SMS Inform boolean
Value is true if SMS inform is enabled. Default false
Optional
enableEmailInform Enable Email Inform boolean
Value is true if email inform is enabled. Default false.
Optional
payeeEmail Payee Email string
Required if Enable Email Inform is true and there is no email on the associated payee.
Optional
payeePhone Payee Phone string
Required if Enable SMS Inform is true and there is no phone on the associated payee.
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
onlinecheckwriter-create-mail-check
Version
0.0.2
App
OnlineCheckWriter
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes