View as Markdown
Salesmate icon

Salesmate ACTION

Add Deal

This API is used to add a deal. See docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Salesmate account once, then configure and run Add Deal 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: "salesmate-add-deal",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    salesmate: { authProvisionId: "apn_xxxxxxx" },
    title: "Title",
    primaryContact: 10,
  },
})

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 Deal inputs
Property Type Description
title Title string
Title for the deal.
Required
primaryContact Primary Contact integer
Primary contact for the deal. User can select it from pre-defined contacts or add a quick contact.
Required Dynamic
owner Owner integer
Owner of the deal.
Required Dynamic
pipeline Pipeline string
Select a pipeline from pre-defined pipelines.
Required Dynamic
status Status string
The deal's status like Open, Won or Lost. By default it is Open.
Required Dynamic
stage Stage string
The stage for a deal. like new, contacted, qualified, proposal presented or in negotiation.
Required Dynamic
primaryCompany Primary Company integer
Primary Company for the deal. User can select it from pre-defined companies or add a quick company.
Optional Dynamic
source Source string
The source from where the contact came to know about the user's company or deal's information like ads, internet etc.
Optional Dynamic
estimatedCloseDate Estimated Close Date string
User can select estimated close date for the deal.
Optional
dealValue Deal Value string
This field contains value of the deal.
Optional
currency Currency string
The three-letter ISO currency code, in uppercase.
Optional Dynamic
priority Priority string
Set the priority for the deal like high, low or medium.
Optional Dynamic
dealDescription Description string
This field contains details related to the deal. It has an arbitrary string attached to the deal object.
Optional
tags Tags string[]
This field contains tags associated with a deal.
Optional Dynamic
contactFollowers Followers (contacts) string[]
Array of the followers of particular deal. Every follower has some more attributes like isOwner if the follower is owner or not. follower's id, name, email address, type, photo, image path and can view the deal status.
Optional Dynamic
userFollowers Followers (users) string[]
Array of the followers of particular deal. Every follower has some more attributes like isOwner if the follower is owner or not. follower's id, name, email address, type, photo, image path and can view the deal status.
Optional Dynamic

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
salesmate-add-deal
Version
0.0.2
App
Salesmate
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes