View as Markdown
Elastic Email icon

Elastic Email ACTION

Update Campaign

Update a campaign in an Elastic Email account. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Elastic Email account once, then configure and run Update 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: "elastic_email-update-campaign",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    elastic_email: { authProvisionId: "apn_xxxxxxx" },
    campaign: "Campaign",
    name: "Campaign Name",
  },
})

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.

Update Campaign inputs
Property Type Description
campaign Campaign string
The name of a campaign
Required Dynamic
name Campaign Name string
The name of the campaign
Optional
from From string
Your e-mail with an optional name (e.g.: email@domain.com or John Doe <email@domain.com>)
Optional
recipientListNames Recipient List Names string[]
Names of lists from your Account to read recipients from
Optional Dynamic
recipientSegmentNames Recipient Segment Names string[]
Names of segments from your Account to read recipients from
Optional Dynamic
replyTo Reply To string
To what address should the recipients reply to (e.g. email@domain.com or John Doe <email@domain.com>)
Optional
subject Subject string
Default subject of email
Optional
templateName Template Name string
The name of template
Optional Dynamic
status Campaign Status string
The status of a campaign
Optional
excludeRecipientListNames Exclude Recipient List Names string[]
Names of lists from your Account to exclude from the campaign
Optional Dynamic
excludeRecipientSegmentNames Exclude Recipient Segment Names string[]
Names of segments from your Account to exclude from the campaign
Optional Dynamic

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
elastic_email-update-campaign
Version
0.0.1
App
Elastic Email
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes