View as Markdown
Sunshine Conversations icon

Sunshine Conversations ACTION

Update Conversation

Update a conversation. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Sunshine Conversations account once, then configure and run Update Conversation 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: "sunshine_conversations-update-conversation",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sunshine_conversations: { authProvisionId: "apn_xxxxxxx" },
    userId: "User ID",
    conversationId: "Conversation ID",
  },
})

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 Conversation inputs
Property Type Description
userId User ID string
The ID of the user received from your Conversations Webhook to filter conversations.
Required
conversationId Conversation ID string
The ID of the conversation to get messages for.
Required Dynamic
displayName Display Name string
A friendly name for the conversation, may be displayed to the business or the user
Optional
description Description string
A short text describing the conversation
Optional
iconUrl Icon URL string
A custom conversation icon url. The image must be in either JPG, PNG, or GIF format
Optional
metadata Metadata object
Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size
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
sunshine_conversations-update-conversation
Version
0.0.3
App
Sunshine Conversations
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes