View as Markdown
Elastic Email icon

Elastic Email ACTION

Create Segment

Create a segment in an Elastic Email account. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

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

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 Segment inputs
Property Type Description
name Segment Name string
The name of the segment
Required
rule Rule string
SQL-like rule to determine which Contacts belong to this Segment. Help for building a segment rule can be found here
Required

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