View as Markdown
Goodbits icon

Goodbits ACTION

Update Subscriber Status

Update the status of a subscriber. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Goodbits account once, then configure and run Update Subscriber Status 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: "goodbits-update-subscriber-status",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    goodbits: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    status: "Status",
  },
})

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.

Update Subscriber Status inputs
Property Type Description
email Email string
Subscriber's email address
Required
status Status string
New status of the subscriber
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
goodbits-update-subscriber-status
Version
0.0.3
App
Goodbits
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes