← Click2Mail

Create Job with Click2Mail API

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

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

Trusted by 800,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 Create Job with the Click2Mail API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Create Job action
    1. Connect your Click2Mail account
    2. Select a Document Class
    3. Select a Layout
    4. Select a Envelope
    5. Select a Color
    6. Select a Paper Type
    7. Select a Print Option
    8. Optional- Select a Document Id
    9. Optional- Select a Address Id
    10. Optional- Configure RTN Name
    11. Optional- Configure RTN Organization
    12. Optional- Configure RTN Address1
    13. Optional- Configure RTN Address2
    14. Optional- Configure RTN City
    15. Optional- Configure RTN State
    16. Optional- Configure RTN Zip
    17. Optional- Select a Mail Class
    18. Optional- Configure APP Signature
    19. Optional- Select a Project Id
    20. Optional- Configure Mailing Date
    21. Optional- Configure Quantity
    22. Optional- Select a Job Document Id
    23. Optional- Configure Job Address Id
    24. Optional- Configure Business Reply Address Id
    25. Optional- Configure Courtesy Reply Address Id
    26. Optional- Configure Return Address Id
  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

Create Job with Click2Mail API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Click2Mail
 
Try it
Create Job with Click2Mail API on New Submission from Typeform API
Typeform + Click2Mail
 
Try it
Create Job with Click2Mail API on Custom Events from Zoom API
Zoom + Click2Mail
 
Try it
Create Job with Click2Mail API on New Submission (Instant) from Jotform API
Jotform + Click2Mail
 
Try it
Create Job with Click2Mail API on New Scheduled Tasks from Pipedream API
Pipedream + Click2Mail
 
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.

Create Job on Click2Mail
Description:Creates a new new job in your account. [See the documentation](https://developers.click2mail.com/reference/post_2).
Version:0.0.1
Key:click2mail2-create-job

Code

import click2mail2 from "../../click2mail2.app.mjs";
import {
  COLOR,
  ENVELOPE,
  LAYOUT,
  MAILCLASS,
  PAPERTYPE,
  PRINTOPTION,
} from "../../common/constants.mjs";

export default {
  key: "click2mail2-create-job",
  name: "Create Job",
  version: "0.0.1",
  description: "Creates a new new job in your account. [See the documentation](https://developers.click2mail.com/reference/post_2).",
  type: "action",
  props: {
    click2mail2,
    documentClass: {
      propDefinition: [
        click2mail2,
        "documentClass",
      ],
    },
    layout: {
      type: "string",
      label: "Layout",
      description: "The specific type of the product",
      options: LAYOUT,
    },
    envelope: {
      type: "string",
      label: "Envelope",
      description: "If this is an enveloped product this determines the envelope in which the product is to be mailed; otherwise provide no value.",
      options: ENVELOPE,
    },
    color: {
      type: "string",
      label: "Color",
      description: "Print in color or black and white.",
      options: COLOR,
    },
    paperType: {
      type: "string",
      label: "Paper Type",
      description: "Sets the paper the mailing is to be printed on.",
      options: PAPERTYPE,
    },
    printOption: {
      type: "string",
      label: "Print Option",
      description: "Sets simplex or duplex printing.",
      options: PRINTOPTION,
    },
    documentId: {
      propDefinition: [
        click2mail2,
        "documentId",
      ],
      optional: true,
    },
    addressId: {
      propDefinition: [
        click2mail2,
        "addressId",
      ],
      optional: true,
    },
    rtnName: {
      type: "string",
      label: "RTN Name",
      description: "Return address Name.",
      optional: true,
    },
    rtnOrganization: {
      type: "string",
      label: "RTN Organization",
      description: "Return address Organization.",
      optional: true,
    },
    rtnaddress1: {
      type: "string",
      label: "RTN Address1",
      description: "Return address line 1.",
      optional: true,
    },
    rtnaddress2: {
      type: "string",
      label: "RTN Address2",
      description: "Return address line 2.",
      optional: true,
    },
    rtnCity: {
      type: "string",
      label: "RTN City",
      description: "Return address City.",
      optional: true,
    },
    rtnState: {
      type: "string",
      label: "RTN State",
      description: "Return address State.",
      optional: true,
    },
    rtnZip: {
      type: "string",
      label: "RTN Zip",
      description: "Return address Zip.",
      optional: true,
    },
    mailClass: {
      type: "string",
      label: "Mail Class",
      description: "Overrides the default of First Class for mailed products.",
      options: MAILCLASS,
      optional: true,
    },
    appSignature: {
      type: "string",
      label: "APP Signature",
      description: "This is a short signature to identify orders that come from your app.",
      optional: true,
    },
    projectId: {
      propDefinition: [
        click2mail2,
        "projectId",
      ],
      optional: true,
    },
    mailingDate: {
      type: "string",
      label: "Mailing Date",
      description: "Used to schedule the mailing date in the future. Format YYYYMMDD. If not provided the order will be mailed on the next available on the next business day. The business day cut off is 8PM EST.",
      optional: true,
    },
    quantity: {
      type: "string",
      label: "Quantity",
      description: "For products that do not use mailing lists. Quantity to print.",
      optional: true,
    },
    jobDocumentId: {
      propDefinition: [
        click2mail2,
        "jobDocumentId",
        ({ documentId }) => ({
          documentId,
        }),
      ],
      optional: true,
    },
    jobAddressId: {
      type: "string",
      label: "Job Address Id",
      description: "Address List Id of the job version.",
      optional: true,
    },
    businessReplyAddressId: {
      type: "integer",
      label: "Business Reply Address Id",
      description: "If you are mailing a business reply mail product use this to specify the busines reply address and permit information already in your account.",
      optional: true,
    },
    courtesyReplyAddressId: {
      type: "integer",
      label: "Courtesy Reply Address Id",
      description: "If you are mailing a courtesy reply mail product use this to specify a courtesy reply address already in your account.",
      optional: true,
    },
    returnAddressId: {
      type: "integer",
      label: "Return Address Id",
      description: "You may use the return address id to specify a return address already in your account.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      click2mail2,
      ...params
    } = this;

    const response = await click2mail2.create({
      $,
      path: "jobs",
      params: {
        productionTime: "Next Day",
        ...params,
      },
    });

    $.export("$summary", `A new job with Id: ${response.id} was successfully created!`);
    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
Click2Mailclick2mail2appThis component uses the Click2Mail app.
Document ClassdocumentClassstringSelect a value from the drop down menu:Postcard 6 x 11Postcard 5 x 8Postcard 4.25 x 6Postcard 3.5 x 5Postcard 4 x 9Postcard 6 x 9Notecard 4.25 x 5.5Notecard - Folded 4.25 x 5.5Rack Card 4 x 9 - MailedFlyer 8.5 x 11Brochure 11 x 8.5Letter 8.5 x 11Letter 8.5 x 14Secure Self Mailer 8.5 x 11Booklet Self Mailer 8.5 x 11Booklet 8.5 x 11 - Address Front PageBooklet 8.5 x 11 - Address Back PageReply Letter 8.5 x 11Reply Postcard 4.25 x 6Certified Letter 8.5 x 11Certified Self Mailer 8.5 x 11Certified Self Mailer - with Green Card ReceiptPriority Letter 8.5 x 11Priority Mail Express Letter 8.5 x 11EDDM Mailer 6.25 x 11EDDM Mailer 6.5 x 9EDDM Mailer 8.5 x 12EDDM Mailer 8.5 x 11Postcard 3.5 x 5 - ShippedBrochure 11 x 8.5 - ShippedPostcard 4.25 x 6 - ShippedPostcard 5 x 8 - ShippedPostcard 6 x 11 - ShippedPostcard 6.5 x 9 - ShippedCardstock 12 x 4.5 - ShippedFlyer 8.5 x 11 - ShippedPostcard 4 x 9 - ShippedRack Card 4 x 9 - ShippedPostcard 4.25 x 6 Movers Format
LayoutlayoutstringSelect a value from the drop down menu:Address on Separate PageAddress on First PagePicture and Address First PageAddress Back Page
EnvelopeenvelopestringSelect a value from the drop down menu:#10 Double WindowBest Fit#10 Open Window Envelope6 x 9.5 Double Window6 x 9.5 Open WindowFlat Envelope
ColorcolorstringSelect a value from the drop down menu:Full ColorBlack and White
Paper TypepaperTypestringSelect a value from the drop down menu:White 24#Off-White 28#Canary 24#White 28#White 28# Matte
Print OptionprintOptionstringSelect a value from the drop down menu:Printing One sidePrinting both sides
Document IddocumentIdstringSelect a value from the drop down menu.
Address IdaddressIdstringSelect a value from the drop down menu.
RTN NamertnNamestring

Return address Name.

RTN OrganizationrtnOrganizationstring

Return address Organization.

RTN Address1rtnaddress1string

Return address line 1.

RTN Address2rtnaddress2string

Return address line 2.

RTN CityrtnCitystring

Return address City.

RTN StatertnStatestring

Return address State.

RTN ZiprtnZipstring

Return address Zip.

Mail ClassmailClassstringSelect a value from the drop down menu:First ClassStandardFirst Class Live StampFirst Class Specialty StampFirst Class No Move Update
APP SignatureappSignaturestring

This is a short signature to identify orders that come from your app.

Project IdprojectIdintegerSelect a value from the drop down menu.
Mailing DatemailingDatestring

Used to schedule the mailing date in the future. Format YYYYMMDD. If not provided the order will be mailed on the next available on the next business day. The business day cut off is 8PM EST.

Quantityquantitystring

For products that do not use mailing lists. Quantity to print.

Job Document IdjobDocumentIdstringSelect a value from the drop down menu.
Job Address IdjobAddressIdstring

Address List Id of the job version.

Business Reply Address IdbusinessReplyAddressIdinteger

If you are mailing a business reply mail product use this to specify the busines reply address and permit information already in your account.

Courtesy Reply Address IdcourtesyReplyAddressIdinteger

If you are mailing a courtesy reply mail product use this to specify a courtesy reply address already in your account.

Return Address IdreturnAddressIdinteger

You may use the return address id to specify a return address already in your account.

Authentication

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

Click2Mail requires their users enter their Click2Mail username and password in order to connect to their API. For more info, refer to Click2Mail’s documentation.

About Click2Mail

We build tech that lets you send mail from your computer in just a few clicks. Yes, you can call us the #MailNerds.

More Ways to Use Click2Mail

Actions

Create Document with the Click2Mail API

Creates a new document in your account from an uploaded file or a URL. See the documentation for file. See the documentation for URL

 
Try it

Explore Other Apps

1
-
24
of
2,000+
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 (REST API)
Salesforce (REST API)
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 Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
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.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
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.