View as Markdown
SMSTools icon

SMSTools ACTION

Add Contact to Opt-Out List

Adds a selected contact to the opt-out list, stopping further communications. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's SMSTools account once, then configure and run Add Contact to Opt-Out 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: "smstools-add-contact-opt-out",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    smstools: { authProvisionId: "apn_xxxxxxx" },
    contactNumber: "Contact Number",
  },
})

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 Opt-Out List inputs
Property Type Description
contactNumber Contact Number string
Select a contact number to add to the opt-out list.
Required 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
smstools-add-contact-opt-out
Version
0.0.2
App
SMSTools
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes