View as Markdown
Stannp icon

Stannp ACTION

Create a New Campaign

Create a new campaign in Stannp. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Stannp account once, then configure and run Create a New Campaign 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: "stannp-create-campaign",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    stannp: { authProvisionId: "apn_xxxxxxx" },
    name: "Campaign Name",
    type: "Campaign Type",
  },
})

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 a New Campaign inputs
Property Type Description
name Campaign Name string
Name your campaign for reference.
Required
type Campaign Type string
The type of campaign this will be. Make sure the image is in the correct format.
Required
templateId Template ID string
Select the template ID
Optional
groupId Group ID string
Select the group ID
Optional Dynamic
whatRecipients What Recipients string
What recipients do you want this campaign to go to?
Optional
addons Addons string
If you have an addon code.
Optional
admail Admail boolean
Set to true to benefit from admail discounts. Must comply with advertising mail restrictions.
Optional
file PDF File Path or URL string
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
front Front Image Path or URL string
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
back Back Image Path or URL string
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
syncDir SyncDir dir
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
stannp-create-campaign
Version
0.1.2
App
Stannp
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes