View as Markdown
Salesforce icon

Salesforce ACTION

Create Opportunity

Create a Salesforce opportunity (a potential deal with an amount and close date). Requires Name, StageName and CloseDate - use Describe Object on Opportunity to list the valid StageName values for your org. Use Find Records on Account to get the AccountId to attach the deal to. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Salesforce account once, then configure and run Create Opportunity 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: "salesforce_rest_api-create-opportunity",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    salesforce_rest_api: { authProvisionId: "apn_xxxxxxx" },
    ContactId: "Contact ID",
    CloseDate: "Close Date",
  },
})

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.

Create Opportunity inputs
Property Type Description
ContactId Contact ID string
ID of the contact associated with this opportunity, set as the primary contact (Salesforce's 15- or 18-character record ID, e.g. 003XX000004TmiQ). Use SOQL Query to find the Contact ID.
Optional
CloseDate Close Date string
Date when the opportunity is expected to close.
Required
Description Description string
Text description of the opportunity. Limit: 32,000 characters.
Optional
Name Name string
A name for this opportunity. Limit: 120 characters
Required
StageName Stage Name string
Current stage of this record. This controls several other fields on an opportunity.
Required
additionalFields Additional Fields object
Other fields to set for this record as name -> value pairs. Values are parsed as JSON where applicable. Example: {"Industry": "Technology", "AnnualRevenue": 1000000}. Use Describe Object to discover valid field names.
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
salesforce_rest_api-create-opportunity
Version
0.4.1
App
Salesforce
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes