Salesforce

Learn how to use Salesforce with Composio

Overview

SLUG: SALESFORCE

Description

Salesforce is a leading CRM platform integrating sales, service, marketing, and analytics to build customer relationships and drive business growth

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to full,refresh_token
bearer_token
string
subdomain
stringDefaults to loginRequired
suffix.one
stringDefaults to /services/data/v61.0Required

Connecting to Salesforce

Create an auth config

Use the dashboard to create an auth config for the Salesforce toolkit. This allows you to connect multiple Salesforce accounts to Composio for agents to use.

1

Select App

Navigate to Salesforce.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Salesforce Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4salesforce_auth_config_id = "ac_YOUR_SALESFORCE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Salesforce: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, salesforce_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Salesforce toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["SALESFORCE"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Create Salesforce Account

Description

Deprecated: creates a new salesforce account using a json post request, requiring 'name'; specific fields (e.g., custom, dunsnumber) may have org-level prerequisites.

Action Parameters

AccountNumber
string
AccountSource
string
Active__c
string
AnnualRevenue
integer
BillingCity
string
BillingCountry
string
BillingGeocodeAccuracy
string
BillingLatitude
integer
BillingLongitude
integer
BillingPostalCode
string
BillingState
string
BillingStreet
string
CleanStatus
string
CreatedById
string
CreatedDate
string
CustomerPriority__c
string
DandbCompanyId
string
Description
string
DunsNumber
string
Fax
string
Id
string
Industry
string
IsDeleted
boolean
Jigsaw
string
JigsawCompanyId
string
LastActivityDate
string
LastModifiedById
string
LastModifiedDate
string
LastReferencedDate
string
LastViewedDate
string
MasterRecordId
string
NaicsCode
string
NaicsDesc
string
Name
stringRequired
NumberOfEmployees
integer
NumberofLocations__c
integer
OperatingHoursId
string
OwnerId
string
Ownership
string
ParentId
string
Phone
string
PhotoUrl
string
Rating
string
SLAExpirationDate__c
string
SLASerialNumber__c
string
SLA__c
string
ShippingCity
string
ShippingCountry
string
ShippingGeocodeAccuracy
string
ShippingLatitude
integer
ShippingLongitude
integer
ShippingPostalCode
string
ShippingState
string
ShippingStreet
string
Sic
string
SicDesc
string
Site
string
SystemModstamp
string
TickerSymbol
string
Tradestyle
string
Type
string
UpsellOpportunity__c
string
Website
string
YearStarted
string
attributes__type
string
attributes__url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add contact to campaign

Description

Adds a contact to a campaign by creating a campaignmember record, allowing you to track campaign engagement.

Action Parameters

campaign_id
stringRequired
contact_id
stringRequired
status
stringDefaults to Sent

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add lead to campaign

Description

Adds a lead to a campaign by creating a campaignmember record, allowing you to track campaign engagement.

Action Parameters

campaign_id
stringRequired
lead_id
stringRequired
status
stringDefaults to Sent

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add product to opportunity

Description

Adds a product (line item) to an opportunity. the product must exist in a pricebook entry that's associated with the opportunity's pricebook.

Action Parameters

description
string
discount
number
opportunity_id
stringRequired
pricebook_entry_id
stringRequired
quantity
numberRequired
service_date
string
total_price
number
unit_price
number

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Apply lead assignment rules

Description

Applies configured lead assignment rules to a specific lead, automatically routing it to the appropriate owner based on your organization's rules.

Action Parameters

lead_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Associate contact to account

Description

Associates a contact with an account by updating the contact's accountid field.

Action Parameters

account_id
stringRequired
contact_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Clone opportunity with products

Description

Clones an opportunity and optionally its products (line items). creates a new opportunity with the same field values and products as the original.

Action Parameters

clone_products
booleanDefaults to True
close_date
string
new_name
string
opportunity_id
stringRequired
stage_name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Clone record

Description

Creates a copy of an existing salesforce record by reading its data, removing system fields, and creating a new record. optionally apply field updates to the clone.

Action Parameters

field_updates
object
object_type
stringRequired
record_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Complete task

Description

Marks a task as completed with optional completion notes. this is a convenience action that updates the task status to 'completed'.

Action Parameters

completion_notes
string
task_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create account

Description

Creates a new account in salesforce with the specified information.

Action Parameters

account_source
string
annual_revenue
number
billing_city
string
billing_country
string
billing_postal_code
string
billing_state
string
billing_street
string
description
string
fax
string
industry
string
name
stringRequired
number_of_employees
integer
parent_id
string
phone
string
shipping_city
string
shipping_country
string
shipping_postal_code
string
shipping_state
string
shipping_street
string
sic_desc
string
type
string
website
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create campaign

Description

Creates a new campaign in salesforce with the specified information.

Action Parameters

actual_cost
number
budgeted_cost
number
description
string
end_date
string
expected_response
number
expected_revenue
number
is_active
boolean
name
stringRequired
number_sent
number
parent_id
string
start_date
string
status
string
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create campaign record

Description

Deprecated: creates a new campaign record in salesforce; if 'parentid' is provided, it must be a valid id of an existing campaign record, and if 'ownerid' is provided, it must be a valid id of an active user.

Action Parameters

ActualCost
integer
AmountAllOpportunities
integer
AmountWonOpportunities
integer
BudgetedCost
integer
CampaignMemberRecordTypeId
string
CreatedById
string
CreatedDate
string
Description
string
EndDate
string
ExpectedResponse
integer
ExpectedRevenue
integer
Id
string
IsActive
boolean
IsDeleted
boolean
LastActivityDate
string
LastModifiedById
string
LastModifiedDate
string
LastReferencedDate
string
LastViewedDate
string
Name
stringRequired
NumberOfContacts
integer
NumberOfConvertedLeads
integer
NumberOfLeads
integer
NumberOfOpportunities
integer
NumberOfResponses
integer
NumberOfWonOpportunities
integer
NumberSent
integer
OwnerId
string
ParentId
string
StartDate
string
Status
string
SystemModstamp
string
Type
string
attributes__type
string
attributes__url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create contact

Description

Creates a new contact in salesforce with the specified information.

Action Parameters

account_id
string
birthdate
string
department
string
description
string
email
string
first_name
string
last_name
stringRequired
lead_source
string
mailing_city
string
mailing_country
string
mailing_postal_code
string
mailing_state
string
mailing_street
string
mobile_phone
string
phone
string
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create lead

Description

Creates a new lead in salesforce with the specified information.

Action Parameters

annual_revenue
number
city
string
company
stringRequired
country
string
description
string
email
string
first_name
string
industry
string
last_name
stringRequired
lead_source
string
number_of_employees
integer
phone
string
postal_code
string
rating
string
state
string
status
string
street
string
title
string
website
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create lead

Description

Deprecated: creates a new lead in salesforce, requiring `lastname` and `company` unless person accounts are enabled and `company` is null.

Action Parameters

AnnualRevenue
integer
City
string
CleanStatus
string
Company
stringRequired
CompanyDunsNumber
string
ConvertedAccountId
string
ConvertedContactId
string
ConvertedDate
string
ConvertedOpportunityId
string
Country
string
CreatedById
string
CreatedDate
string
CurrentGenerators__c
string
DandbCompanyId
string
Description
string
Email
string
EmailBouncedDate
string
EmailBouncedReason
string
FirstName
string
IndividualId
string
Industry
string
IsConverted
boolean
IsDeleted
boolean
IsPriorityRecord
boolean
IsUnreadByOwner
boolean
Jigsaw
string
JigsawContactId
string
LastActivityDate
string
LastModifiedById
string
LastModifiedDate
string
LastName
stringRequired
LastReferencedDate
string
LastViewedDate
string
LeadSource
string
MasterRecordId
string
NumberOfEmployees
integer
NumberofLocations__c
integer
OwnerId
string
Phone
string
PhotoUrl
string
PostalCode
string
Primary__c
string
ProductInterest__c
string
Rating
string
SICCode__c
string
Salutation
string
State
string
Status
string
Street
string
SystemModstamp
string
Title
string
Website
string
attributes__type
string
attributes__url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a new contact

Description

Deprecated: creates a new contact in salesforce; 'lastname' is required, an existing 'accountid' must be used if provided, and any custom fields (ending with ' c') must be predefined.

Action Parameters

AccountId
string
AssistantName
string
AssistantPhone
string
Birthdate
string
CleanStatus
string
ContactSource
string
CreatedById
string
CreatedDate
string
Department
string
Description
string
Email
string
EmailBouncedDate
string
EmailBouncedReason
string
Fax
string
FirstName
string
HomePhone
string
Id
string
IndividualId
string
IsDeleted
boolean
IsEmailBounced
boolean
IsPriorityRecord
boolean
Jigsaw
string
JigsawContactId
string
Languages__c
string
LastActivityDate
string
LastCURequestDate
string
LastCUUpdateDate
string
LastModifiedById
string
LastModifiedDate
string
LastName
stringRequired
LastReferencedDate
string
LastViewedDate
string
LeadSource
string
Level__c
string
MailingCity
string
MailingCountry
string
MailingGeocodeAccuracy
string
MailingLatitude
integer
MailingLongitude
integer
MailingPostalCode
string
MailingState
string
MailingStreet
string
MasterRecordId
string
MobilePhone
string
Name
string
OtherCity
string
OtherCountry
string
OtherGeocodeAccuracy
string
OtherLatitude
integer
OtherLongitude
integer
OtherPhone
string
OtherPostalCode
string
OtherState
string
OtherStreet
string
OwnerId
string
Phone
string
PhotoUrl
string
ReportsToId
string
Salutation
string
SystemModstamp
string
Title
string
attributes__type
string
attributes__url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create note

Description

Creates a new note attached to a salesforce record with the specified title and content.

Action Parameters

body
string
is_private
boolean
owner_id
string
parent_id
stringRequired
title
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a note record

Description

Deprecated: creates a new note record in salesforce, associated with an existing salesforce object via `parentid`, automatically including a `content-type: application/json` header.

Action Parameters

Body
stringRequired
CreatedById
string
CreatedDate
string
Id
string
IsDeleted
boolean
IsPrivate
boolean
LastModifiedById
string
LastModifiedDate
string
OwnerId
string
ParentId
stringRequired
SystemModstamp
string
Title
stringRequired
attributes__type
string
attributes__url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create opportunity

Description

Creates a new opportunity in salesforce with the specified information.

Action Parameters

account_id
string
amount
number
close_date
stringRequired
contact_id
string
description
string
lead_source
string
name
stringRequired
next_step
string
pricebook2_id
string
probability
number
stage_name
stringRequired
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create opportunity record

Description

Deprecated: creates a new opportunity record in salesforce; `name`, `stagename`, and `closedate` are mandatory, and ensure any referenced ids (e.g., `accountid`, `campaignid`) are valid and corresponding salesforce features are enabled if used.

Action Parameters

AccountId
string
Amount
integer
CampaignId
string
CloseDate
stringRequired
ContactId
string
CreatedById
string
CreatedDate
string
CurrentGenerators__c
string
DeliveryInstallationStatus__c
string
Description
string
ExpectedRevenue
integer
Fiscal
string
FiscalQuarter
integer
FiscalYear
integer
ForecastCategory
string
ForecastCategoryName
string
HasOpenActivity
boolean
HasOpportunityLineItem
boolean
HasOverdueTask
boolean
Id
string
IsClosed
boolean
IsDeleted
boolean
IsPrivate
boolean
IsWon
boolean
LastActivityDate
string
LastAmountChangedHistoryId
string
LastCloseDateChangedHistoryId
string
LastModifiedById
string
LastModifiedDate
string
LastReferencedDate
string
LastStageChangeDate
string
LastViewedDate
string
LeadSource
string
MainCompetitors__c
string
Name
stringRequired
NextStep
string
OrderNumber__c
string
OwnerId
string
Pricebook2Id
string
Probability
integer
PushCount
integer
StageName
stringRequired
SystemModstamp
string
TotalOpportunityQuantity
integer
TrackingNumber__c
string
Type
string
attributes__type
string
attributes__url
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create task

Description

Creates a new task in salesforce to track activities, to-dos, and follow-ups related to contacts, leads, or other records.

Action Parameters

activity_date
string
description
string
is_reminder_set
boolean
owner_id
string
priority
stringDefaults to Normal
reminder_date_time
string
status
stringDefaults to Not Started
subject
stringRequired
what_id
string
who_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete account

Description

Permanently deletes an account from salesforce. this action cannot be undone.

Action Parameters

account_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a lead object by its id

Description

Deprecated: permanently deletes an existing lead object from salesforce using its unique id.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete campaign

Description

Permanently deletes a campaign from salesforce. this action cannot be undone.

Action Parameters

campaign_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete contact

Description

Permanently deletes a contact from salesforce. this action cannot be undone.

Action Parameters

contact_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete lead

Description

Permanently deletes a lead from salesforce. this action cannot be undone.

Action Parameters

lead_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete note

Description

Permanently deletes a note from salesforce. this action cannot be undone.

Action Parameters

note_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete opportunity

Description

Permanently deletes an opportunity from salesforce. this action cannot be undone.

Action Parameters

opportunity_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Execute SOQL query

Description

Deprecated: executes the provided soql query against salesforce; the query must begin with 'select'.

Action Parameters

soql_query
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Fetch account by ID with query

Description

Deprecated: use this action to retrieve a salesforce account by its unique id, which must be a valid and existing salesforce account id; you can optionally specify a comma-delimited list of fields to return.

Action Parameters

fields
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Fetch modified or unmodified sobjects

Description

Deprecated: fetches sobjects from `/sobjects` based on caller-set 'if-modified-since' (returns objects modified after a date, or 304 status if none) or 'if-unmodified-since' (returns objects if unmodified since a date, or 412 status if modified) http headers.

Action Parameters

If-Modified-Since
string
If-Unmodified-Since
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get account

Description

Retrieves a specific account by id from salesforce, returning all available fields.

Action Parameters

account_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get campaign

Description

Retrieves a specific campaign by id from salesforce, returning all available fields.

Action Parameters

campaign_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get contact

Description

Retrieves a specific contact by id from salesforce, returning all available fields.

Action Parameters

contact_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get dashboard

Description

Gets detailed metadata for a specific dashboard including its components, layout, and filters.

Action Parameters

dashboard_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get lead

Description

Retrieves a specific lead by id from salesforce, returning all available fields.

Action Parameters

lead_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get note

Description

Retrieves a specific note by id from salesforce, returning all available fields.

Action Parameters

note_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve Note with conditions

Description

Deprecated: retrieves a salesforce note object by its id, optionally specifying which fields to return; the note id must exist.

Action Parameters

fields
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get opportunity

Description

Retrieves a specific opportunity by id from salesforce, returning all available fields.

Action Parameters

opportunity_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get report metadata

Description

Gets detailed metadata for a specific report including its structure, columns, filters, and groupings.

Action Parameters

report_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get report instance results

Description

Gets the results of a report instance created by running a report. check status to see if report has completed.

Action Parameters

instance_id
stringRequired
report_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get user info

Description

Retrieves information about the current user or a specific user in salesforce.

Action Parameters

include_permissions
boolean
user_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List accounts

Description

Lists accounts from salesforce using soql query, allowing flexible filtering, sorting, and field selection.

Action Parameters

query
stringDefaults to SELECT Id, Name, Type, Industry, Phone, Website, BillingCity, ShippingCity, AnnualRevenue, NumberOfEmployees FROM Account

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List campaigns

Description

Lists campaigns from salesforce using soql query, allowing flexible filtering, sorting, and field selection.

Action Parameters

query
stringDefaults to SELECT Id, Name, Type, Status, StartDate, EndDate, BudgetedCost, ActualCost, ExpectedRevenue, IsActive, ParentId FROM Campaign

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List contacts

Description

Lists contacts from salesforce using soql query, allowing flexible filtering, sorting, and field selection.

Action Parameters

query
stringDefaults to SELECT Id, FirstName, LastName, Email, Phone, Title, Department, AccountId FROM Contact

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List dashboards

Description

Lists all dashboards available in salesforce with basic metadata including name, id, and urls.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List email templates

Description

Lists available email templates in salesforce with filtering and search capabilities.

Action Parameters

folder_name
string
include_body
boolean
is_active_only
booleanDefaults to True
limit
integerDefaults to 50
order_by
stringDefaults to Name
order_direction
stringDefaults to ASC
search_term
string
template_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List leads

Description

Lists leads from salesforce using soql query, allowing flexible filtering, sorting, and field selection.

Action Parameters

query
stringDefaults to SELECT Id, FirstName, LastName, Company, Title, Email, Phone, Status, LeadSource, Rating, Industry FROM Lead

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List notes

Description

Lists notes from salesforce using soql query, allowing flexible filtering, sorting, and field selection.

Action Parameters

query
stringDefaults to SELECT Id, Title, Body, IsPrivate, ParentId, OwnerId, CreatedDate, LastModifiedDate FROM Note

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List opportunities

Description

Lists opportunities from salesforce using soql query, allowing flexible filtering, sorting, and field selection.

Action Parameters

query
stringDefaults to SELECT Id, Name, StageName, CloseDate, Amount, Probability, Type, LeadSource, AccountId FROM Opportunity

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List reports

Description

Lists all reports available in salesforce with basic metadata including name, id, and urls.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Log call

Description

Logs a completed phone call as a task in salesforce with call-specific details like duration, type, and disposition.

Action Parameters

call_date
string
call_disposition
string
call_duration_seconds
integer
call_type
stringDefaults to Outbound
comments
string
subject
stringDefaults to Call
what_id
string
who_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Log email activity

Description

Creates an emailmessage record to log email activity in salesforce, associating it with related records.

Action Parameters

bcc_address
string
cc_address
string
from_address
stringRequired
html_body
string
is_client_managed
booleanDefaults to True
is_externally_visible
booleanDefaults to True
is_incoming
boolean
message_date
string
parent_id
string
related_to_id
stringRequired
status
stringDefaults to 3
subject
stringRequired
text_body
string
to_address
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Mass transfer ownership

Description

Transfers ownership of multiple records to a new owner in a single operation using salesforce's composite api for better performance.

Action Parameters

new_owner_id
stringRequired
object_type
stringRequired
record_ids
arrayRequired
send_notification_email
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Query contacts by name

Description

Deprecated: finds salesforce contact records by name using a case-insensitive search.

Action Parameters

contact_name
stringRequired
fields
stringDefaults to Id,Name,Email,Phone,AccountId
limit
integerDefaults to 20

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Query report

Description

Deprecated: executes a salesforce report synchronously by its `id` and `reporttype`, optionally with dynamic ad-hoc adjustments like filters or groupings, and returns its data without modifying the saved report.

Action Parameters

aggregates
array
allowedInCustomDetailFormula
boolean
buckets
array
chart
array
crossFilters
array
currency
string
customDetailFormula
array
customSummaryFormula
array
detailColumns
array
developerName
string
division
string
folderId
string
groupingsAcross
array
groupingsDown
array
hasDetailRows
booleanDefaults to True
hasRecordCount
booleanDefaults to True
historicalSnapshotDates
array
id
stringRequired
name
string
presentationOptions
object
reportBooleanFilter
string
reportFilters
array
reportFormat
stringRequired
reportType
objectRequired
scope
string
showGrandTotal
booleanDefaults to True
showSubtotals
booleanDefaults to True
sortBy
array
standardDateFilter
object
standardFilters
array
topRows
object
userOrHierarchyFilterId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove account by unique identifier

Description

Deprecated: deletes an existing salesforce account using its unique id, returning an empty response on success (http 204).

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove a specific contact by id

Description

Deprecated: permanently deletes a specific contact from salesforce using its unique id, which must correspond to an existing record.

Action Parameters

id
stringRequired

Action Response

data
object
error
string
successful
booleanRequired

Tool Name: Remove campaign object by id

Description

Deprecated: permanently deletes a specific campaign sobject in salesforce using its unique id.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove from campaign

Description

Removes a lead or contact from a campaign by deleting the campaignmember record. provide either the member id (lead/contact id) or the specific campaign member id.

Action Parameters

campaign_id
stringRequired
campaign_member_id
string
member_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove note object by id

Description

Deprecated: permanently deletes an existing salesforce note object identified by its unique id.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove opportunity by id

Description

Deprecated: permanently deletes an existing salesforce opportunity by its id; if the opportunity does not exist, a 'not found' (404) error occurs.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve account data and error responses

Description

Deprecated: retrieves comprehensive metadata for the salesforce account sobject, detailing its properties, recent records, and related resource urls.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve campaign data with error handling

Description

Deprecated: retrieves comprehensive information and metadata for the salesforce campaign sobject, provided it is enabled and accessible in the organization, and features robust error handling.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve contact object metadata

Description

Deprecated: retrieves comprehensive metadata (e.g., fields, data types, picklist values) for the salesforce contact sobject; this action does not retrieve individual contact records.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve lead by id

Description

Deprecated: retrieves details for a salesforce lead by its id; the specified lead id must exist in salesforce.

Action Parameters

fields
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve lead data with various responses

Description

Deprecated: retrieves lead sobject data from salesforce, such as recently viewed leads or general lead object information.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve note object information

Description

Deprecated: retrieves comprehensive metadata for the salesforce 'note' sobject, if it is enabled and accessible, to understand its structure and capabilities.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve opportunities data

Description

Deprecated: retrieves all available opportunity records, representing potential revenue-generating deals, from salesforce.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve opportunity by id with optional fields

Description

Deprecated: retrieves a salesforce opportunity by its id; the opportunity id must exist.

Action Parameters

fields
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve specific campaign object details

Description

Deprecated: retrieves details for a specific salesforce campaign object by its id, optionally limiting to specified fields; the campaign object must exist.

Action Parameters

fields
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve specific contact by id

Description

Deprecated: retrieves a salesforce contact by its unique id; the id must correspond to an existing contact record in salesforce.

Action Parameters

fields
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Run report

Description

Runs a report and returns the results. creates a report instance that can be checked for completion.

Action Parameters

report_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Run SOQL query

Description

Executes a soql query against salesforce data. returns records matching the query with pagination support.

Action Parameters

query
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search accounts

Description

Search for salesforce accounts using multiple criteria like name, industry, type, location, or contact information.

Action Parameters

billing_city
string
billing_country
string
billing_state
string
fields
stringDefaults to Id,Name,Type,Industry,Phone,Website,BillingStreet,BillingCity,BillingState,BillingCountry,NumberOfEmployees,AnnualRevenue
industry
string
limit
integerDefaults to 50
name
string
phone
string
type
string
website
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search campaigns

Description

Search for salesforce campaigns using multiple criteria like name, type, status, date range, or active status.

Action Parameters

fields
stringDefaults to Id,Name,Type,Status,StartDate,EndDate,IsActive,Description,BudgetedCost,ActualCost,NumberOfContacts,NumberOfLeads
is_active
boolean
limit
integerDefaults to 50
name
string
start_date_from
string
start_date_to
string
status
string
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search contacts

Description

Search for salesforce contacts using multiple criteria like name, email, phone, account, or title.

Action Parameters

account_name
string
email
string
fields
stringDefaults to Id,Name,FirstName,LastName,Email,Phone,MobilePhone,Title,AccountId,Account.Name
limit
integerDefaults to 50
name
string
phone
string
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search leads

Description

Search for salesforce leads using multiple criteria like name, email, phone, company, title, status, or lead source.

Action Parameters

company
string
email
string
fields
stringDefaults to Id,Name,FirstName,LastName,Email,Phone,Title,Company,Status,LeadSource,CreatedDate
lead_source
string
limit
integerDefaults to 50
name
string
phone
string
status
string
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search notes

Description

Search for salesforce notes using multiple criteria like title, body content, parent record, owner, or creation date.

Action Parameters

body
string
created_date_from
string
created_date_to
string
fields
stringDefaults to Id,Title,Body,ParentId,Parent.Name,OwnerId,Owner.Name,IsPrivate,CreatedDate,LastModifiedDate
is_private
boolean
limit
integerDefaults to 50
owner_name
string
parent_name
string
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search opportunities

Description

Search for salesforce opportunities using multiple criteria like name, account, stage, amount, close date, or status.

Action Parameters

account_name
string
amount_max
number
amount_min
number
close_date_from
string
close_date_to
string
fields
stringDefaults to Id,Name,AccountId,Account.Name,StageName,Amount,CloseDate,IsClosed,IsWon,Probability,LeadSource,CreatedDate
is_closed
boolean
is_won
boolean
lead_source
string
limit
integerDefaults to 50
name
string
stage_name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search tasks

Description

Search for salesforce tasks using multiple criteria like subject, status, priority, assigned user, related records, or dates.

Action Parameters

account_name
string
activity_date_from
string
activity_date_to
string
assigned_to_name
string
contact_name
string
fields
stringDefaults to Id,Subject,Status,Priority,ActivityDate,IsClosed,Description,OwnerId,Owner.Name,WhatId,What.Name,WhoId,Who.Name
is_closed
boolean
limit
integerDefaults to 50
priority
string
status
string
subject
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Send email

Description

Sends an email through salesforce with options for recipients, attachments, and activity logging.

Action Parameters

attachment_ids
string
bcc_addresses
string
body
stringRequired
cc_addresses
string
is_html
boolean
log_email
boolean
recipient_id
string
related_record_id
string
sender_address
string
sender_type
stringDefaults to CurrentUser
subject
stringRequired
to_addresses
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Send email from template

Description

Sends an email using a predefined salesforce email template with merge field support.

Action Parameters

add_threading_tokens
boolean
additional_to_addresses
string
attachment_ids
string
bcc_addresses
string
cc_addresses
string
log_email
booleanDefaults to True
recipient_id
stringRequired
related_record_id
string
sender_address
string
sender_type
stringDefaults to CurrentUser
template_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Send mass email

Description

Sends bulk emails to multiple recipients, either using a template or custom content. processes in batches for better performance.

Action Parameters

batch_size
integerDefaults to 50
body
string
is_html
boolean
log_emails
booleanDefaults to True
recipient_ids
arrayRequired
sender_address
string
sender_type
stringDefaults to CurrentUser
subject
string
template_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update account

Description

Updates an existing account in salesforce with the specified changes. only provided fields will be updated.

Action Parameters

account_id
stringRequired
account_source
string
annual_revenue
number
billing_city
string
billing_country
string
billing_postal_code
string
billing_state
string
billing_street
string
description
string
fax
string
industry
string
name
string
number_of_employees
integer
parent_id
string
phone
string
shipping_city
string
shipping_country
string
shipping_postal_code
string
shipping_state
string
shipping_street
string
sic_desc
string
type
string
website
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update account by id

Description

Deprecated: updates specified fields of an existing salesforce account object identified by its unique id; field names are case-sensitive and read-only fields are ignored.

Action Parameters

AccountNumber
string
AccountSource
string
Active__c
string
AnnualRevenue
integer
BillingCity
string
BillingCountry
string
BillingGeocodeAccuracy
string
BillingLatitude
integer
BillingLongitude
integer
BillingPostalCode
string
BillingState
string
BillingStreet
string
CleanStatus
string
CreatedById
string
CreatedDate
string
CustomerPriority__c
string
DandbCompanyId
string
Description
string
DunsNumber
string
Fax
string
Id
string
Industry
string
IsDeleted
boolean
Jigsaw
string
JigsawCompanyId
string
LastActivityDate
string
LastModifiedById
string
LastModifiedDate
string
LastReferencedDate
string
LastViewedDate
string
MasterRecordId
string
NaicsCode
string
NaicsDesc
string
Name
string
NumberOfEmployees
integer
NumberofLocations__c
integer
OperatingHoursId
string
OwnerId
string
Ownership
string
ParentId
string
Phone
string
PhotoUrl
string
Rating
string
SLAExpirationDate__c
string
SLASerialNumber__c
string
SLA__c
string
ShippingCity
string
ShippingCountry
string
ShippingGeocodeAccuracy
string
ShippingLatitude
integer
ShippingLongitude
integer
ShippingPostalCode
string
ShippingState
string
ShippingStreet
string
Sic
string
SicDesc
string
Site
string
SystemModstamp
string
TickerSymbol
string
Tradestyle
string
Type
string
UpsellOpportunity__c
string
Website
string
YearStarted
string
attributes__type
string
attributes__url
string
id
stringRequired

Action Response

data
object
error
string
successful
booleanRequired

Tool Name: Update campaign

Description

Updates an existing campaign in salesforce with the specified changes. only provided fields will be updated.

Action Parameters

actual_cost
numberDefaults to -1
budgeted_cost
numberDefaults to -1
campaign_id
stringRequired
description
string
end_date
string
expected_response
numberDefaults to -1
expected_revenue
numberDefaults to -1
is_active
boolean
name
string
number_sent
numberDefaults to -1
parent_id
string
start_date
string
status
string
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Campaign By ID

Description

Deprecated: updates specific fields of an existing campaign in salesforce, identified by its unique `id`, which must already exist.

Action Parameters

ActualCost
integer
AmountAllOpportunities
integer
AmountWonOpportunities
integer
BudgetedCost
integer
CampaignMemberRecordTypeId
string
CreatedById
string
CreatedDate
string
Description
string
EndDate
string
ExpectedResponse
integer
ExpectedRevenue
integer
Id
string
IsActive
boolean
IsDeleted
boolean
LastActivityDate
string
LastModifiedById
string
LastModifiedDate
string
LastReferencedDate
string
LastViewedDate
string
Name
string
NumberOfContacts
integer
NumberOfConvertedLeads
integer
NumberOfLeads
integer
NumberOfOpportunities
integer
NumberOfResponses
integer
NumberOfWonOpportunities
integer
NumberSent
integer
OwnerId
string
ParentId
string
StartDate
string
Status
string
SystemModstamp
string
Type
string
attributes__type
string
attributes__url
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update contact

Description

Updates an existing contact in salesforce with the specified changes. only provided fields will be updated.

Action Parameters

account_id
string
birthdate
string
contact_id
stringRequired
department
string
description
string
email
string
first_name
string
last_name
string
mailing_city
string
mailing_country
string
mailing_postal_code
string
mailing_state
string
mailing_street
string
mobile_phone
string
phone
string
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update contact by id

Description

Deprecated: updates specified fields of an existing salesforce contact by its id; at least one field must be provided for modification.

Action Parameters

AccountId
string
AssistantName
string
AssistantPhone
string
Birthdate
string
CleanStatus
string
ContactSource
string
CreatedById
string
CreatedDate
string
Department
string
Description
string
Email
string
EmailBouncedDate
string
EmailBouncedReason
string
Fax
string
FirstName
string
HomePhone
string
Id
string
IndividualId
string
IsDeleted
boolean
IsEmailBounced
boolean
IsPriorityRecord
boolean
Jigsaw
string
JigsawContactId
string
Languages__c
string
LastActivityDate
string
LastCURequestDate
string
LastCUUpdateDate
string
LastModifiedById
string
LastModifiedDate
string
LastName
string
LastReferencedDate
string
LastViewedDate
string
LeadSource
string
Level__c
string
MailingCity
string
MailingCountry
string
MailingGeocodeAccuracy
string
MailingLatitude
integer
MailingLongitude
integer
MailingPostalCode
string
MailingState
string
MailingStreet
string
MasterRecordId
string
MobilePhone
string
Name
string
OtherCity
string
OtherCountry
string
OtherGeocodeAccuracy
string
OtherLatitude
integer
OtherLongitude
integer
OtherPhone
string
OtherPostalCode
string
OtherState
string
OtherStreet
string
OwnerId
string
Phone
string
PhotoUrl
string
ReportsToId
string
Salutation
string
SystemModstamp
string
Title
string
attributes__type
string
attributes__url
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update lead

Description

Updates an existing lead in salesforce with the specified changes. only provided fields will be updated.

Action Parameters

annual_revenue
numberDefaults to -1
city
string
company
string
country
string
description
string
email
string
first_name
string
industry
string
last_name
string
lead_id
stringRequired
lead_source
string
number_of_employees
integerDefaults to -1
phone
string
postal_code
string
rating
string
state
string
status
string
street
string
title
string
website
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update lead by ID with JSON payload

Description

Deprecated: updates specified fields of an existing lead in salesforce via its unique id (path parameter), returning http 204 on success or error details on failure; request body must contain at least one field to update.

Action Parameters

AnnualRevenue
number
City
string
CleanStatus
string
Company
string
CompanyDunsNumber
string
ConvertedAccountId
string
ConvertedContactId
string
ConvertedDate
string
ConvertedOpportunityId
string
Country
string
CreatedById
string
CreatedDate
string
CurrentGenerators__c
string
DandbCompanyId
string
Description
string
Email
string
EmailBouncedDate
string
EmailBouncedReason
string
Fax
string
FirstName
string
GeocodeAccuracy
string
Id
string
IndividualId
string
Industry
string
IsConverted
boolean
IsDeleted
boolean
IsPriorityRecord
boolean
IsUnreadByOwner
boolean
Jigsaw
string
JigsawContactId
string
LastActivityDate
string
LastModifiedById
string
LastModifiedDate
string
LastName
string
LastReferencedDate
string
LastViewedDate
string
Latitude
number
LeadSource
string
Longitude
number
MasterRecordId
string
MobilePhone
string
Name
string
NumberOfEmployees
integer
NumberofLocations__c
integer
OwnerId
string
Phone
string
PhotoUrl
string
PostalCode
string
Primary__c
string
ProductInterest__c
string
Rating
string
SICCode__c
string
Salutation
string
State
string
Status
string
Street
string
SystemModstamp
string
Title
string
Website
string
attributes__type
string
attributes__url
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update note

Description

Updates an existing note in salesforce with the specified changes. only provided fields will be updated.

Action Parameters

body
string
is_private
boolean
note_id
stringRequired
owner_id
string
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update opportunity

Description

Updates an existing opportunity in salesforce with the specified changes. only provided fields will be updated.

Action Parameters

account_id
string
amount
numberDefaults to -1
close_date
string
contact_id
string
description
string
lead_source
string
name
string
next_step
string
opportunity_id
stringRequired
probability
numberDefaults to -1
stage_name
string
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update opportunity by id

Description

Deprecated: updates specified fields of an existing salesforce opportunity by its id; the opportunity must exist, and some fields (like name, stagename, closedate) may have specific salesforce validation rules if being modified, while read-only fields update indirectly based on other changes.

Action Parameters

AccountId
string
Amount
integer
CampaignId
string
CloseDate
string
ContactId
string
CreatedById
string
CreatedDate
string
CurrentGenerators__c
string
DeliveryInstallationStatus__c
string
Description
string
ExpectedRevenue
integer
Fiscal
string
FiscalQuarter
integer
FiscalYear
integer
ForecastCategory
string
ForecastCategoryName
string
HasOpenActivity
boolean
HasOpportunityLineItem
boolean
HasOverdueTask
boolean
Id
string
IsClosed
boolean
IsDeleted
boolean
IsPrivate
boolean
IsWon
boolean
LastActivityDate
string
LastAmountChangedHistoryId
string
LastCloseDateChangedHistoryId
string
LastModifiedById
string
LastModifiedDate
string
LastReferencedDate
string
LastStageChangeDate
string
LastViewedDate
string
LeadSource
string
MainCompetitors__c
string
Name
string
NextStep
string
OrderNumber__c
string
OwnerId
string
Pricebook2Id
string
Probability
integer
PushCount
integer
StageName
string
SystemModstamp
string
TotalOpportunityQuantity
integer
TrackingNumber__c
string
Type
string
attributes__type
string
attributes__url
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update specific note by id

Description

Deprecated: use `update specific note by id` instead. updates specified fields of an existing salesforce note sobject identified by its id; the note must already exist.

Action Parameters

Body
string
CreatedById
string
CreatedDate
string
Id
string
IsDeleted
boolean
IsPrivate
boolean
LastModifiedById
string
LastModifiedDate
string
OwnerId
string
ParentId
string
SystemModstamp
string
Title
string
attributes__type
string
attributes__url
string
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update task

Description

Updates an existing task in salesforce with new information. only provided fields will be updated.

Action Parameters

activity_date
string
description
string
is_reminder_set
boolean
priority
string
reminder_date_time
string
status
string
subject
string
task_id
stringRequired
what_id
string
who_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired