← Stannp

Create a New Campaign with Stannp API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create a New Campaign with the Stannp 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 Create a New Campaign with the Stannp API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Create a New Campaign action
    1. Connect your Stannp account
    2. Configure Campaign Name
    3. Select a Campaign Type
    4. Optional- Configure Template ID
    5. Optional- Select a Group ID
    6. Optional- Select a What Recipients
    7. Optional- Configure Addons
    8. Optional- Configure Admail
    9. Optional- Configure PDF File Path or URL
    10. Optional- Configure Front Image Path or URL
    11. Optional- Configure Back Image Path or URL
  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 a New Campaign with Stannp API on New Inventory Update from Vend API
Vend + Stannp
 
Try it
Create a New Campaign with Stannp API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Stannp
 
Try it
Create a New Campaign with Stannp API on New Submission from Typeform API
Typeform + Stannp
 
Try it
Create a New Campaign with Stannp API on Custom Events from Zoom API
Zoom + Stannp
 
Try it
Create a New Campaign with Stannp API on New Submission (Instant) from Jotform API
Jotform + Stannp
 
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 a New Campaign on Stannp
Description:Create a new campaign in Stannp. [See the documentation](https://www.stannp.com/us/direct-mail-api/campaigns)
Version:0.1.0
Key:stannp-create-campaign

Code

import FormData from "form-data";
import {
  TYPE_OPTIONS, WHAT_RECIPIENTS_OPTIONS,
} from "../../common/constants.mjs";
import { getFileData } from "../../common/utils.mjs";
import stannp from "../../stannp.app.mjs";

export default {
  key: "stannp-create-campaign",
  name: "Create a New Campaign",
  description: "Create a new campaign in Stannp. [See the documentation](https://www.stannp.com/us/direct-mail-api/campaigns)",
  version: "0.1.0",
  type: "action",
  props: {
    stannp,
    name: {
      type: "string",
      label: "Campaign Name",
      description: "Name your campaign for reference.",
    },
    type: {
      type: "string",
      label: "Campaign Type",
      description: "The type of campaign this will be. Make sure the image is in the correct format.",
      options: TYPE_OPTIONS,
    },
    templateId: {
      type: "string",
      label: "Template ID",
      description: "Select the template ID",
      optional: true,
    },
    groupId: {
      propDefinition: [
        stannp,
        "groupId",
      ],
      optional: true,
    },
    whatRecipients: {
      type: "string",
      label: "What Recipients",
      description: "What recipients do you want this campaign to go to?",
      options: WHAT_RECIPIENTS_OPTIONS,
      optional: true,
    },
    addons: {
      type: "string",
      label: "Addons",
      description: "If you have an addon code.",
      optional: true,
    },
    admail: {
      type: "boolean",
      label: "Admail",
      description: "Set to true to benefit from admail discounts. Must comply with advertising mail restrictions.",
      optional: true,
    },
    file: {
      type: "string",
      label: "PDF File Path or URL",
      description: "A PDF file to use as the design artwork. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.pdf`)",
      optional: true,
      reloadProps: true,
    },
    front: {
      type: "string",
      label: "Front Image Path or URL",
      description: "A PDF or JPG file to use as the front image. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.jpg`)",
      optional: true,
      reloadProps: true,
    },
    back: {
      type: "string",
      label: "Back Image Path or URL",
      description: "A PDF or JPG file to use as the back image. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.jpg`)",
      optional: true,
      reloadProps: true,
    },
  },
  async additionalProps() {
    let optional = true;
    if (this.file || this.front || this.back) {
      optional = false;
    }
    return {
      size: {
        type: "string",
        label: "Size",
        description: "Example '4x6' or '6x9' or 6x11'",
        optional,
      },
    };
  },
  async run({ $ }) {
    const {
      stannp,
      templateId,
      groupId,
      whatRecipients,
      file,
      front,
      back,
      admail,
      ...data
    } = this;

    const formData = new FormData();

    if (file) {
      const {
        stream, metadata,
      } = await getFileData(file);
      formData.append("file", stream, metadata);
    }
    if (front) {
      const {
        stream, metadata,
      } = await getFileData(front);
      formData.append("front", stream, metadata);
    }
    if (back) {
      const {
        stream, metadata,
      } = await getFileData(back);
      formData.append("back", stream, metadata);
    }

    if (templateId) formData.append("template_id", templateId);
    if (groupId) formData.append("group_id", groupId);
    if (whatRecipients) formData.append("what_recipients", whatRecipients);
    if (typeof admail === "boolean") formData.append("admail", `${admail}`);
    for (const [
      key,
      value,
    ] of Object.entries(data)) {
      formData.append(key, value);
    }

    const response = await stannp.createCampaign({
      $,
      data: formData,
      headers: formData.getHeaders(),
    });

    $.export("$summary", `Successfully created campaign with ID: ${response.data}`);
    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
StannpstannpappThis component uses the Stannp app.
Campaign Namenamestring

Name your campaign for reference.

Campaign TypetypestringSelect a value from the drop down menu:4x6-postcard6x9-postcardus-letter
Template IDtemplateIdstring

Select the template ID

Group IDgroupIdstringSelect a value from the drop down menu.
What RecipientswhatRecipientsstringSelect a value from the drop down menu:allvalidnot_validint
Addonsaddonsstring

If you have an addon code.

Admailadmailboolean

Set to true to benefit from admail discounts. Must comply with advertising mail restrictions.

PDF File Path or URLfilestring

A PDF file to use as the design artwork. Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.pdf)

Front Image Path or URLfrontstring

A PDF or JPG file to use as the front image. Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.jpg)

Back Image Path or URLbackstring

A PDF or JPG file to use as the back image. Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myFile.jpg)

Authentication

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

To retrieve your API Key,

  • Navigate to your Stannp account and sign in
  • Go to “Settings” > “API Settings”

About Stannp

Create and send postal Direct Mail campaigns: letters or postcards.

More Ways to Use Stannp

Triggers

New Campaign Created from the Stannp API

Emit new event when a new campaign is created in Stannp.

 
Try it
New Recipient Created from the Stannp API

Emit new event when a new recipient is created.

 
Try it

Actions

Create a New Recipient with the Stannp API

Creates a new recipient in a specified group. See the Stannp documentation

 
Try it
Get a Single Campaign with the Stannp API

Get a single campaign based on the provided campaign ID. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,700+
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.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream workflows
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.
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.
Anthropic (Claude)
Anthropic (Claude)
AI research and products that put safety at the frontier. Introducing Claude, a next-generation AI assistant for your tasks, no matter the scale.
Google Sheets
Google Sheets
Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.
Telegram
Telegram
Telegram, is a cloud-based, cross-platform, encrypted instant messaging (IM) service.
Google Drive
Google Drive
Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.
Pinterest
Pinterest
Pinterest is a visual discovery engine for finding ideas like recipes, home and style inspiration, and more.
Google Calendar
Google Calendar
With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.
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.
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
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.