View as Markdown
Ortto icon

Ortto ACTION

Opt Out of SMS

Allows a user to opt-out from all SMS communications. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Ortto account once, then configure and run Opt Out of SMS 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: "ortto-opt-out-sms",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ortto: { authProvisionId: "apn_xxxxxxx" },
    userEmail: "User 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.

Opt Out of SMS inputs
Property Type Description
userEmail User Email string
Specify the user email to opt out from all SMS communications.
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
ortto-opt-out-sms
Version
0.0.2
App
Ortto
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes