View as Markdown
Octopush SMS icon

Octopush SMS ACTION

Add Contact

Adds a new contact to a list in the Octopush SMS Gateway. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Octopush SMS account once, then configure and run Add Contact 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: "octopush_sms-add-contact",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    octopush_sms: { authProvisionId: "apn_xxxxxxx" },
    phone: "Phone Number",
    firstName: "First Name",
  },
})

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 inputs
Property Type Description
phone Phone Number string
Phone number of the contact
Required
firstName First Name string
First name of the contact
Required
lastName Last Name string
Last name of the contact
Required
listName List Name string
Name of the list to which the contact should be added
Optional
tag Tag Name string
Name of the tag that will be attached to the contact
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
octopush_sms-add-contact
Version
0.0.2
App
Octopush SMS
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes