View as Markdown
robly icon

robly ACTION

Add Contact To List

Add a contact to one or more sub-lists. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's robly account once, then configure and run Add Contact 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: "robly-add-contact-to-list",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    robly: { authProvisionId: "apn_xxxxxxx" },
    email: "Contact Email",
    subListId: 10,
  },
})

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 Contact To List inputs
Property Type Description
email Contact Email string
The email address of the contact
Required Dynamic
subListId Sub List integer
The ID of the sub-list to add the contact to
Required Dynamic
includeAutomations Include Automations boolean
When true, the automations associated with the Sub List will be triggered
Required
includeAutoresponder Include Autoresponder boolean
When true, this flag will trigger sending the member the autoresponder message when they are subscribed to a list
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
robly-add-contact-to-list
Version
0.0.1
App
robly
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes