Upsales ACTION
Update Order
Updates an existing order in Upsales. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Upsales account once, then configure and run Update Order 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: "upsales-update-order",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
upsales: { authProvisionId: "apn_xxxxxxx" },
orderId: "Order ID",
description: "Description",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "upsales-update-order",
"configured_props": {
"upsales": { "authProvisionId": "apn_xxxxxxx" },
"orderId": "Order ID",
"description": "Description"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "upsales",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "upsales-update-order",
arguments: {
orderId: "Order ID",
description: "Description",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
orderId Order ID | string | The order's unique ID. Use Get Order List to find an ID. Required Dynamic |
description Description | string | Order description Optional |
date Date | string | Order date (ISO 8601 format, e.g., 2024-01-15T10:00:00Z) Optional |
userId User ID | string | User who created the order Optional Dynamic |
clientId Client ID | string | Company this order belongs to Optional Dynamic |
stageId Stage ID | string | Stage to which the order belongs to Optional Dynamic |
probability Probability | integer | Probability percentage, between 0-100 Optional |
closeDate Close Date | string | Date when Order became 100% or 0% (ISO 8601 format) Optional |
notes Notes | string | Order notes Optional |
contactId Contact ID | string | Contact reference of the company that ordered Optional Dynamic |
projects Projects | object | Campaign payload as a JSON object, e.g. { "id": 42, "name": "Q1 Retention" } Optional |
clientConnectionId Client Connection ID | string | Second company connected to this order Optional Dynamic |
currencyRate Currency Rate | string | Currency rate in relation to the base currency of the account Optional |
currency Currency | string | Currency for the order (e.g., USD, EUR, SEK) Optional |
custom Custom Fields | string[] | Array of custom field/value pairs in JSON format. Each entry should be a string like { "fieldId": 1, "value": "my value" } Optional |
competitorId Competitor ID | integer | Competitor ID. Find competitors at https://integration.upsales.com/api/v2/competitors/ Optional |
lostReason Lost Reason | integer | Lost Reason ID. Find lost reasons at https://integration.upsales.com/api/v2/fieldTranslations/?type=orderlostreason Optional |
notify Notify | boolean | Whether to notify other users in the account about this order. Default is true. Optional |
orderRow Order Rows | string[] | Array of order row objects in JSON format. Each entry should be a string like { "product": { "id": 123 }, "quantity": 2, "price": 100 }. See the documentation for all available properties. 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
- upsales-update-order
- Version
- 0.0.1
- App
- Upsales
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗