Skip to main content
DocuPost logo
  • Category: documents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 3
  • Triggers: 0
  • Slug: DOCUPOST
  • Version: 20261101_00

Tools

Slug: DOCUPOST_GET_BALANCEReturn the connected DocuPost account’s numeric balance. This read does not reveal currency, plan, tier, or sandbox status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUPOST_SEND_LETTERSubmit one PDF letter for paid printing and US postal delivery using a PDF URL and sender and recipient addresses. This non-idempotent operation can deduct funds and create real mail; avoid automatically retrying ambiguous results, as acceptance does not prove printing or delivery and later errors may appear on the mailing detail page.

Input Parameters

boolean
Print in color when true; black and white when false.
object
required
U.S. return address printed for the sender.
string
required
Public URL of a PDF up to 10 MB; 8.5x11 pages are recommended.
object
required
U.S. postal recipient printed on the envelope.
string ("usps_first_class" | "usps_standard" | "usps_priority_mail" | "usps_priority_mail_express")
USPS mail class used for the letter.
boolean
Print on both sides of each sheet when true.
string ("certified" | "certified_return_receipt")
Optional certified-mail service; valid only with usps_first_class.
string
Optional internal note shown in DocuPost’s dashboard and CSV exports, at most 40 characters.
boolean
Include a prepaid return envelope. This is the single agent-facing form of DocuPost’s duplicate return-envelope parameter names.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DOCUPOST_SEND_POSTCARDSubmit one postcard for paid printing and U.S. postal delivery. This is a non-idempotent physical-mail operation: one call can deduct funds and create real mail, so confirm both artworks and all addresses before calling and never automatically retry an ambiguous result. HTTP acceptance is asynchronous and does not prove later printing or delivery; invalid artwork dimensions can fail after acceptance.

Input Parameters

string ("4x6" | "6x9")
Printed postcard size in inches.
object
required
U.S. return address printed for the sender.
object
required
U.S. postal recipient printed on the postcard.
string
required
Public URL for the postcard back artwork; 1875x1275 pixels and PNG are recommended.
string
required
Public URL for the postcard front artwork; 1875x1275 pixels and PNG are recommended.
string
Optional internal note shown in DocuPost’s dashboard and CSV exports; DocuPost publishes no postcard-specific length limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not