View as Markdown
Emailoctopus icon

Emailoctopus ACTION

Add Subscribers To List

Add subscribers to a list, See the docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Emailoctopus account once, then configure and run Add Subscribers To List 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: "emailoctopus-add-subscribers-to-list",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    emailoctopus: { authProvisionId: "apn_xxxxxxx" },
    listId: "List",
    email: "Email",
  },
})

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.

Add Subscribers To List inputs
Property Type Description
listId List string
List where the source will be performed.
Required Dynamic
email Email string
The email address of the contact.
Required
fields Fields object
An object containing key/value pairs of field values, using the field's tag as the key. For example: {"FirstName": "John", "LastName": "Doe"}
Optional
tags Tags string[]
An array of tags to add to the contact.
Optional
status Status string
The initial status of the contact. If omitted, the value will default to PENDING for lists with double opt-in enabled, or SUBSCRIBED for lists without.
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
emailoctopus-add-subscribers-to-list
Version
0.0.4
App
Emailoctopus
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes