← DocuPost

Mail Postcard with DocuPost API

Pipedream makes it easy to connect APIs for DocuPost and 2,400+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Mail Postcard with the DocuPost API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Mail Postcard with the DocuPost API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Mail Postcard action
    1. Connect your DocuPost account
    2. Configure Front Image URL
    3. Configure Back Image URL
    4. Configure Recipient's Name
    5. Configure Recipient's Address Line 1
    6. Optional- Configure Recipient's Address Line 2
    7. Configure Recipient's City
    8. Select a Recipient's State
    9. Configure Recipient's Postal Code
    10. Configure Sender's Name
    11. Configure Sender's Address Line 1
    12. Optional- Configure Sender's Address Line 2
    13. Configure Sender's City
    14. Select a Sender's State
    15. Configure Sender's Postal Code
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Mail Postcard with DocuPost API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + DocuPost
 
Try it
Mail Postcard with DocuPost API on New Submission from Typeform API
Typeform + DocuPost
 
Try it
Mail Postcard with DocuPost API on New Submission (Instant) from Jotform API
Jotform + DocuPost
 
Try it
Mail Postcard with DocuPost API on New Scheduled Tasks from Pipedream API
Pipedream + DocuPost
 
Try it
Mail Postcard with DocuPost API on npm Download Counts from npm API
npm + DocuPost
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Mail Postcard on DocuPost
Description:Dispatches a glossy, color 4x6 postcard via the US Postal Service. [See the documentation](https://help.docupost.com/help/send-postcard-api)
Version:0.0.1
Key:docupost-mail-postcard

Code

import app from "../../docupost.app.mjs";

export default {
  key: "docupost-mail-postcard",
  name: "Mail Postcard",
  description: "Dispatches a glossy, color 4x6 postcard via the US Postal Service. [See the documentation](https://help.docupost.com/help/send-postcard-api)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    frontImage: {
      type: "string",
      label: "Front Image URL",
      description: "A valid image URL for the front of your postcard. Image should be 1875 x 1275. PNG recommended. Your API request will succeed but your mailing will later fail if the image is the incorrect size.",
    },
    backImage: {
      type: "string",
      label: "Back Image URL",
      description: "A valid image URL for the back of your postcard. Image should be 1875 x 1275. PNG recommended. Your API request will succeed but your mailing will later fail if the image is the incorrect size. Important: Your recipient/sender and postage information will be automatically overlaid onto your image. See [this template](https://docupost.s3.us-east-2.amazonaws.com/postcardtemplateback_ip0jws.png) as an example. ",
    },
    toName: {
      propDefinition: [
        app,
        "toName",
      ],
    },
    toAddress1: {
      propDefinition: [
        app,
        "toAddress1",
      ],
    },
    toAddress2: {
      propDefinition: [
        app,
        "toAddress2",
      ],
    },
    toCity: {
      propDefinition: [
        app,
        "toCity",
      ],
    },
    toState: {
      propDefinition: [
        app,
        "toState",
      ],
    },
    toZip: {
      propDefinition: [
        app,
        "toZip",
      ],
    },
    fromName: {
      propDefinition: [
        app,
        "fromName",
      ],
    },
    fromAddress1: {
      propDefinition: [
        app,
        "fromAddress1",
      ],
    },
    fromAddress2: {
      propDefinition: [
        app,
        "fromAddress2",
      ],
    },
    fromCity: {
      propDefinition: [
        app,
        "fromCity",
      ],
    },
    fromState: {
      propDefinition: [
        app,
        "fromState",
      ],
    },
    fromZip: {
      propDefinition: [
        app,
        "fromZip",
      ],
    },
  },
  methods: {
    sendPostcard(args = {}) {
      return this.app.post({
        path: "/sendpostcard",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      sendPostcard,
      frontImage,
      backImage,
      toName,
      toAddress1,
      toAddress2,
      toCity,
      toState,
      toZip,
      fromName,
      fromAddress1,
      fromAddress2,
      fromCity,
      fromState,
      fromZip,
    } = this;

    const response = await sendPostcard({
      $,
      params: {
        front_image: frontImage,
        back_image: backImage,
        to_name: toName,
        to_address1: toAddress1,
        to_address2: toAddress2,
        to_city: toCity,
        to_state: toState,
        to_zip: toZip,
        from_name: fromName,
        from_address1: fromAddress1,
        from_address2: fromAddress2,
        from_city: fromCity,
        from_state: fromState,
        from_zip: fromZip,
      },
    });

    $.export("$summary", "Successfully sent postcard");
    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
DocuPostappappThis component uses the DocuPost app.
Front Image URLfrontImagestring

A valid image URL for the front of your postcard. Image should be 1875 x 1275. PNG recommended. Your API request will succeed but your mailing will later fail if the image is the incorrect size.

Back Image URLbackImagestring

A valid image URL for the back of your postcard. Image should be 1875 x 1275. PNG recommended. Your API request will succeed but your mailing will later fail if the image is the incorrect size. Important: Your recipient/sender and postage information will be automatically overlaid onto your image. See this template as an example.

Recipient's NametoNamestring

The name of the recipient (who the letter/postcard is being sent to). Must be less than 40 characters.

Recipient's Address Line 1toAddress1string

The first line of the recipient's address.

Recipient's Address Line 2toAddress2string

The second line of the recipient's address.

Recipient's CitytoCitystring

The city of the recipient.

Recipient's StatetoStatestringSelect a value from the drop down menu:{ "label": "Alabama", "value": "AL" }{ "label": "Alaska", "value": "AK" }{ "label": "American Samoa", "value": "AS" }{ "label": "Arizona", "value": "AZ" }{ "label": "Arkansas", "value": "AR" }{ "label": "California", "value": "CA" }{ "label": "Colorado", "value": "CO" }{ "label": "Connecticut", "value": "CT" }{ "label": "Delaware", "value": "DE" }{ "label": "District of Columbia", "value": "DC" }{ "label": "Federated States of Micronesia", "value": "FM" }{ "label": "Florida", "value": "FL" }{ "label": "Georgia", "value": "GA" }{ "label": "Guam", "value": "GU" }{ "label": "Hawaii", "value": "HI" }{ "label": "Idaho", "value": "ID" }{ "label": "Illinois", "value": "IL" }{ "label": "Indiana", "value": "IN" }{ "label": "Iowa", "value": "IA" }{ "label": "Kansas", "value": "KS" }{ "label": "Kentucky", "value": "KY" }{ "label": "Louisiana", "value": "LA" }{ "label": "Maine", "value": "ME" }{ "label": "Marshall Islands", "value": "MH" }{ "label": "Maryland", "value": "MD" }{ "label": "Massachusetts", "value": "MA" }{ "label": "Michigan", "value": "MI" }{ "label": "Minnesota", "value": "MN" }{ "label": "Mississippi", "value": "MS" }{ "label": "Missouri", "value": "MO" }{ "label": "Montana", "value": "MT" }{ "label": "Nebraska", "value": "NE" }{ "label": "Nevada", "value": "NV" }{ "label": "New Hampshire", "value": "NH" }{ "label": "New Jersey", "value": "NJ" }{ "label": "New Mexico", "value": "NM" }{ "label": "New York", "value": "NY" }{ "label": "North Carolina", "value": "NC" }{ "label": "North Dakota", "value": "ND" }{ "label": "Northern Mariana Islands", "value": "MP" }{ "label": "Ohio", "value": "OH" }{ "label": "Oklahoma", "value": "OK" }{ "label": "Oregon", "value": "OR" }{ "label": "Palau", "value": "PW" }{ "label": "Pennsylvania", "value": "PA" }{ "label": "Puerto Rico", "value": "PR" }{ "label": "Rhode Island", "value": "RI" }{ "label": "South Carolina", "value": "SC" }{ "label": "South Dakota", "value": "SD" }{ "label": "Tennessee", "value": "TN" }{ "label": "Texas", "value": "TX" }{ "label": "Utah", "value": "UT" }{ "label": "Vermont", "value": "VT" }{ "label": "Virgin Islands", "value": "VI" }{ "label": "Virginia", "value": "VA" }{ "label": "Washington", "value": "WA" }{ "label": "West Virginia", "value": "WV" }{ "label": "Wisconsin", "value": "WI" }{ "label": "Wyoming", "value": "WY" }{ "label": "Armed Forces Europe, the Middle East, and Canada", "value": "AE" }{ "label": "Armed Forces Pacific", "value": "AP" }{ "label": "Armed Forces Americas (except Canada)", "value": "AA" }{ "label": "North", "value": "N" }{ "label": "East", "value": "E" }{ "label": "South", "value": "S" }{ "label": "West", "value": "W" }{ "label": "Northeast", "value": "NE" }{ "label": "Southeast", "value": "SE" }{ "label": "Northwest", "value": "NW" }{ "label": "Southwest", "value": "SW" }
Recipient's Postal CodetoZipstring

The 5-digit postal code for the recipient.

Sender's NamefromNamestring

Your sender/return address name. Must be less than 40 characters.

Sender's Address Line 1fromAddress1string

The first line of your sender/return address.

Sender's Address Line 2fromAddress2string

The second line of your sender/return address.

Sender's CityfromCitystring

The city of your sender/return address.

Sender's StatefromStatestringSelect a value from the drop down menu:{ "label": "Alabama", "value": "AL" }{ "label": "Alaska", "value": "AK" }{ "label": "American Samoa", "value": "AS" }{ "label": "Arizona", "value": "AZ" }{ "label": "Arkansas", "value": "AR" }{ "label": "California", "value": "CA" }{ "label": "Colorado", "value": "CO" }{ "label": "Connecticut", "value": "CT" }{ "label": "Delaware", "value": "DE" }{ "label": "District of Columbia", "value": "DC" }{ "label": "Federated States of Micronesia", "value": "FM" }{ "label": "Florida", "value": "FL" }{ "label": "Georgia", "value": "GA" }{ "label": "Guam", "value": "GU" }{ "label": "Hawaii", "value": "HI" }{ "label": "Idaho", "value": "ID" }{ "label": "Illinois", "value": "IL" }{ "label": "Indiana", "value": "IN" }{ "label": "Iowa", "value": "IA" }{ "label": "Kansas", "value": "KS" }{ "label": "Kentucky", "value": "KY" }{ "label": "Louisiana", "value": "LA" }{ "label": "Maine", "value": "ME" }{ "label": "Marshall Islands", "value": "MH" }{ "label": "Maryland", "value": "MD" }{ "label": "Massachusetts", "value": "MA" }{ "label": "Michigan", "value": "MI" }{ "label": "Minnesota", "value": "MN" }{ "label": "Mississippi", "value": "MS" }{ "label": "Missouri", "value": "MO" }{ "label": "Montana", "value": "MT" }{ "label": "Nebraska", "value": "NE" }{ "label": "Nevada", "value": "NV" }{ "label": "New Hampshire", "value": "NH" }{ "label": "New Jersey", "value": "NJ" }{ "label": "New Mexico", "value": "NM" }{ "label": "New York", "value": "NY" }{ "label": "North Carolina", "value": "NC" }{ "label": "North Dakota", "value": "ND" }{ "label": "Northern Mariana Islands", "value": "MP" }{ "label": "Ohio", "value": "OH" }{ "label": "Oklahoma", "value": "OK" }{ "label": "Oregon", "value": "OR" }{ "label": "Palau", "value": "PW" }{ "label": "Pennsylvania", "value": "PA" }{ "label": "Puerto Rico", "value": "PR" }{ "label": "Rhode Island", "value": "RI" }{ "label": "South Carolina", "value": "SC" }{ "label": "South Dakota", "value": "SD" }{ "label": "Tennessee", "value": "TN" }{ "label": "Texas", "value": "TX" }{ "label": "Utah", "value": "UT" }{ "label": "Vermont", "value": "VT" }{ "label": "Virgin Islands", "value": "VI" }{ "label": "Virginia", "value": "VA" }{ "label": "Washington", "value": "WA" }{ "label": "West Virginia", "value": "WV" }{ "label": "Wisconsin", "value": "WI" }{ "label": "Wyoming", "value": "WY" }{ "label": "Armed Forces Europe, the Middle East, and Canada", "value": "AE" }{ "label": "Armed Forces Pacific", "value": "AP" }{ "label": "Armed Forces Americas (except Canada)", "value": "AA" }{ "label": "North", "value": "N" }{ "label": "East", "value": "E" }{ "label": "South", "value": "S" }{ "label": "West", "value": "W" }{ "label": "Northeast", "value": "NE" }{ "label": "Southeast", "value": "SE" }{ "label": "Northwest", "value": "NW" }{ "label": "Southwest", "value": "SW" }
Sender's Postal CodefromZipstring

The 5-digit postal code for your sender/return address.

Authentication

DocuPost uses API keys for authentication. When you connect your DocuPost account, Pipedream securely stores the keys so you can easily authenticate to DocuPost APIs in both code and no-code steps.

About DocuPost

Mail letters and postcards online. We’ll print, stamp and send U.S. mail for you, from 95¢. Simple, pay-as-you-go pricing.

More Ways to Use DocuPost

Actions

Mail Letter with the DocuPost API

Sends a physical letter via USPS first class mail. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,400+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.