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
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

For code examples, see the Tool calling guide and Provider examples.

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
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
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
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
opportunity_id
stringRequired
pricebook_entry_id
stringRequired
quantity
numberRequired
service_date
total_price
unit_price

Action Response

data
objectRequired
error
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
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
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
new_name
string
opportunity_id
stringRequired
stage_name
string

Action Response

data
objectRequired
error
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_type
stringRequired
record_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Close or abort a job

Description

Tool to close or abort a Salesforce Bulk API v2 ingest job. Use when you need to finalize job processing by closing (state: UploadComplete) or cancel a job by aborting (state: Aborted). This is required for every ingest job - closing queues data for processing, while aborting cancels the job and deletes uploaded data.

Action Parameters

job_id
stringRequired
state
stringRequired

Action Response

data
objectRequired
error
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
successful
booleanRequired

Tool Name: Execute Composite Graph

Description

Tool to execute multiple Salesforce REST API requests in a single call using composite graphs. Use when you need to perform a series of related operations that should either all succeed or all fail together. Composite graphs support up to 500 subrequests per graph (compared to 25 for regular composite requests) and allow referencing outputs from previous subrequests using @{referenceId.fieldName} syntax.

Action Parameters

graphs
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create account

Description

Creates a new account in Salesforce with the specified information.

Action Parameters

account_source
string
annual_revenue
billing_city
string
billing_country
string
billing_postal_code
string
billing_state
string
billing_street
string
custom_fields
description
string
fax
string
industry
string
name
stringRequired
number_of_employees
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
successful
booleanRequired

Tool Name: Create a record

Description

Tool to create a Salesforce record using the UI API. Use when you need to create any type of Salesforce record with layout metadata and formatted field values.

Action Parameters

allow_save_on_duplicate
api_name
stringRequired
composio_execution_message
fields
objectRequired

Action Response

data
objectRequired
error
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
custom_fields
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
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
successful
booleanRequired

Tool Name: Create contact

Description

Creates a new contact in Salesforce with the specified information.

Action Parameters

account_id
string
birthdate
string
custom_fields
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
successful
booleanRequired

Tool Name: Create custom object

Description

Tool to create a custom object in Salesforce using the Metadata API. Use when you need to dynamically create new object types (tables) in Salesforce with custom fields and configurations.

Action Parameters

deployment_status
stringDefaults to Deployed
description
enable_activities
enable_reports
full_name
stringRequired
label
stringRequired
name_field
objectRequired
plural_label
stringRequired
sharing_model
stringDefaults to ReadWrite

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create lead

Description

Creates a new lead in Salesforce with the specified information.

Action Parameters

AnnualRevenue
number
City
string
Company
stringRequired
Country
string
CustomFields
Email
string
FirstName
string
Industry
string
LastName
stringRequired
LeadSource
string
NumberOfEmployees
integer
Phone
string
PostalCode
string
Rating
string
State
string
Status
string
Street
string
Title
string
Website
string
allow_duplicates
boolean

Action Response

data
objectRequired
error
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
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
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
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
custom_fields
is_private
boolean
owner_id
string
parent_id
stringRequired
title
stringRequired

Action Response

data
objectRequired
error
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
CreatedDate
Id
IsDeleted
IsPrivate
LastModifiedById
LastModifiedDate
OwnerId
ParentId
stringRequired
SystemModstamp
Title
stringRequired
attributes__type
attributes__url

Action Response

data
objectRequired
error
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
custom_fields
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
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
successful
booleanRequired

Tool Name: Create SObject record

Description

Tool to create a new Salesforce SObject record. Use when you need to create any type of standard or custom Salesforce object record by specifying the object type and field values.

Action Parameters

fields
objectRequired
sobject_type
stringRequired

Action Response

data
objectRequired
error
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
composio_execution_message
custom_fields
description
string
is_reminder_set
boolean
owner_id
string
priority
stringDefaults to Normal
reminder_date_time
status
stringDefaults to Not Started
subject
stringRequired
what_id
string
who_id
string

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get custom invocable actions

Description

Retrieves the list of custom actions including Flow actions, Apex actions, and invocable processes. Use when you need to discover available custom invocable actions in your Salesforce organization.

Action Parameters

Action Response

data
objectRequired
error
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
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
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
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
successful
booleanRequired

Tool Name: Delete file

Description

Tool to permanently delete a file from Salesforce. Use when you need to remove a file and its content. This operation cannot be undone.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete job query

Description

Tool to delete a Salesforce Bulk API v2 query job. Use when you need to permanently remove a job and its associated data. Only the user who created the job can delete it, and the job must be in a completed state.

Action Parameters

job_id
stringRequired

Action Response

data
objectRequired
error
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
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
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
successful
booleanRequired

Tool Name: Delete sObject record

Description

Tool to delete a single Salesforce record by its ID. Use when you need to permanently remove a specific record from Salesforce. This operation is idempotent - deleting the same record multiple times returns success. Works with standard and custom objects.

Action Parameters

id
stringRequired
sobject_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Describe Global

Description

Tool to retrieve all available Salesforce objects with metadata and organization settings. Use when you need to discover which sObjects exist in the organization, check object capabilities, or retrieve organization encoding and batch size limits. Supports conditional requests via If-Modified-Since header to avoid fetching unchanged data.

Action Parameters

if_modified_since

Action Response

data
objectRequired
error
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
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
id
stringRequired

Action Response

data
objectRequired
error
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
If-Unmodified-Since

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get file information

Description

Tool to retrieve comprehensive metadata and information about a specified file in Salesforce. Use when you need detailed file information including ownership, sharing settings, download URLs, and rendition status.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get file shares

Description

Returns information about the objects with which the specified file has been shared. Use when you need to understand who has access to a specific file in Salesforce.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get a batch of records

Description

Tool to get data for a batch of records from Salesforce UI API. Use when you need to retrieve multiple records in a single API call (up to 200 records).

Action Parameters

fields
layout_types
modes
optional_fields
record_ids
stringRequired

Action Response

data
objectRequired
error
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
successful
booleanRequired

Tool Name: Get directory of supported objects

Description

Tool to get a Salesforce org's active theme and directory of supported objects. Use when you need to discover available objects that are supported by the User Interface API, including their CRUD permissions, labels, and theme information.

Action Parameters

q

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all objects

Description

Retrieves all Salesforce objects (standard and custom) with detailed metadata. Each object includes a 'custom' field to identify custom objects. Use when you need to discover available objects or their capabilities.

Action Parameters

custom_only
page
Defaults to 1
page_size
Defaults to 50

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all fields for an object

Description

Retrieves all fields (standard and custom) for a Salesforce object with complete metadata including field types, constraints, picklist values, and relationships.

Action Parameters

object_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all navigation items

Description

Gets all navigation items (tabs) that the user has access to. Use when you need to retrieve available navigation tabs for display or navigation purposes.

Action Parameters

formFactor
Defaults to Large
navItemNames
page
pageSize
Defaults to 25

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get an app

Description

Tool to get metadata about a specific Salesforce app by ID. Use when you need to retrieve app configuration details and navigation items for a particular application.

Action Parameters

app_id
stringRequired
form_factor

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get API resources by version

Description

Tool to discover available REST API resources for a specified Salesforce API version. Use when you need to find available endpoints and their URIs for a specific API version.

Action Parameters

version

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get apps

Description

Tool to get metadata for all apps a user has access to. Use when you need to list available Salesforce applications or check app navigation items. Metadata for the selected app includes tabs on the app's navigation bar, while other apps don't include tab details.

Action Parameters

form_factor

Action Response

data
objectRequired
error
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
successful
booleanRequired

Tool Name: Get Chatter resources

Description

Tool to access Chatter resources directory. Use when you need to discover available Chatter feeds, groups, users, email digest controls, emojis, extensions, or streams.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get child records

Description

Tool to get child records for a specified parent record and child relationship name. Use when you need to retrieve related records from a parent-child relationship in Salesforce, such as getting all Contacts for an Account or all Opportunities for an Account. Results are paginated with configurable page size.

Action Parameters

fields
optional_fields
page_size
page_token
record_id
stringRequired
relationship_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Compact Layouts

Description

Tool to retrieve compact layout information for multiple Salesforce objects. Use when you need to display object data in compact form for Lightning Experience, mobile apps, or custom interfaces.

Action Parameters

object_list
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get composite resources

Description

Tool to retrieve a list of available composite resources in Salesforce. Use when you need to discover which composite API endpoints are available for batch operations.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get contact

Description

Retrieves a specific contact by ID from Salesforce, returning all available fields.

Action Parameters

contact_id
stringRequired
fields

Action Response

data
objectRequired
error
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
successful
booleanRequired

Tool Name: Get List View Header Actions

Description

Tool to retrieve header actions on list views. Use when you need to get available actions, buttons, and quick actions displayed on a specific list view header in Salesforce.

Action Parameters

list_view_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get file content

Description

Returns the binary content of a Salesforce file, including references to external files. Use when you need to download or retrieve the actual file data from Salesforce.

Action Parameters

file_id
stringRequired
rendition_type
version_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get global actions

Description

Tool to retrieve actions displayed in the Salesforce Global Actions menu with metadata. Use when you need to discover available global actions, quick actions, or custom buttons in the UI.

Action Parameters

actionTypes
apiNames
formFactor

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get job failed record results

Description

Tool to retrieve failed records from a Salesforce Bulk API 2.0 ingest job. Use when you need to get records that failed during a bulk operation, including error messages and original data.

Action Parameters

job_id
stringRequired
locator
max_records

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get job info query

Description

Tool to retrieve information about a Salesforce Bulk API v2 query job. Use when you need to check the status and details of a query job.

Action Parameters

job_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get job query result

Description

Retrieves results for a completed Bulk API v2 query job in CSV format. Supports pagination for large datasets via maxRecords and locator parameters.

Action Parameters

job_id
stringRequired
locator
max_records

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get job successful record results

Description

Tool to retrieve successfully processed records from a Salesforce Bulk API 2.0 ingest job. Use when you need to get records that were successfully created or updated during a bulk operation.

Action Parameters

job_id
stringRequired
locator
max_records

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get job unprocessed record results

Description

Tool to retrieve unprocessed records from a Salesforce Bulk API 2.0 ingest job. Use when you need to get records that were not processed during a bulk operation, typically due to job abortion or interruption.

Action Parameters

job_id
stringRequired
locator
max_records

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get last selected app

Description

Retrieves the app the current user last selected or the app the user sees by default. Use when you need to determine which application the user is currently working in or should be using.

Action Parameters

formFactor

Action Response

data
objectRequired
error
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
successful
booleanRequired

Tool Name: Get organization limits

Description

Tool to retrieve organization limits with max and remaining allocations. Use when you need to check API usage, storage limits, or other resource consumption in Salesforce.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get record count for objects

Description

Tool to retrieve total record counts for specified Salesforce objects. Use when you need to check storage usage or understand data volume for specific sObjects.

Action Parameters

sobjects
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get list views for an object

Description

Returns a collection of list views associated with a Salesforce object. Use when you need to discover available list views for an object like Account, Contact, or Opportunity.

Action Parameters

sobject_api_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get batch of list view metadata

Description

Tool to retrieve metadata for multiple list views in a single batch request. Use when you need to get list view configuration, columns, filters, and sorting for multiple list views at once.

Action Parameters

list_view_ids
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get list view metadata

Description

Returns list view metadata by object and list view API name. Use when you need to retrieve complete metadata information for a specific list view, including display columns, filters, sort order, permissions, and user preferences.

Action Parameters

list_view_api_name
stringRequired
sobject_api_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get list view records by API name

Description

Retrieves paginated record data for a specified list view using the object and list view API names. Use when you need to fetch records that match a specific list view's filters and sorting criteria. Returns the same data that powers Lightning Experience list views.

Action Parameters

fields
list_view_api_name
stringRequired
optionalFields
pageSize
pageToken
searchTerm
sobject_api_name
stringRequired
sortBy
where

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get list view records by ID

Description

Returns record data for a list view by its ID. Use when you need to retrieve records from a specific Salesforce list view.

Action Parameters

fields
list_view_id
stringRequired
optional_fields
page_size
page_token
sort_by

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get list view results

Description

Retrieves the results of a list view for a specified sObject. Returns column definitions and record data with a 2,000 record limit per response.

Action Parameters

list_view_id
stringRequired
sobject
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get lookup field suggestions

Description

Tool to retrieve lookup field suggestions for editing lookup fields with search filtering. Use when searching for records to populate a lookup field, supporting typeahead, recent, and full-text search.

Action Parameters

dependent_field_bindings
field_api_name
stringRequired
form_factor
object_api_name
stringRequired
page
page_size
q
search_type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get most recently used list view records

Description

Tool to retrieve record data for an object's most recently used (MRU) list view. Use when you need to get the records that a user has recently accessed for a specific Salesforce object type.

Action Parameters

fields
optional_fields
page_size
page_token
sobject_api_name
stringRequired
sort_by

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get MRU list view metadata

Description

Tool to retrieve MRU list view metadata for a Salesforce object. Use when you need to understand the structure and configuration of the most recently used list view for an object.

Action Parameters

sobject_api_name
stringRequired

Action Response

data
objectRequired
error
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
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
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get opportunity

Description

Retrieves a specific opportunity by ID from Salesforce, returning all available fields.

Action Parameters

fields
opportunity_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get org limits

Description

Tool to list information about limits in your Salesforce org. Use when you need to check resource allocations and usage.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search with parameters

Description

Tool to execute a simple parameterized search in Salesforce using GET method. Use when you need to perform a quick search across all Salesforce objects with just a search term. For advanced filtering options, use the POST parameterizedSearch endpoint instead.

Action Parameters

q
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get photo actions

Description

Tool to retrieve available photo actions for Salesforce pages. Use when you need to get photo management actions for user or group pages. Currently, only group and user pages support photo actions.

Action Parameters

action_types
form_factor
record_ids
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Values for All Picklist Fields

Description

Tool to get values for all picklist fields of a record type, including dependent picklists. Use when you need to retrieve available picklist options for a specific object and record type, especially for dependent picklist hierarchies.

Action Parameters

record_type_id
stringRequired
sobject_api_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get quick actions

Description

Tool to retrieve a list of global quick actions available in the Salesforce organization. Use when you need to discover available quick actions or get their metadata.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get record edit page actions

Description

Tool to get available actions on record edit pages. Use when you need to retrieve metadata about actions (standard actions, custom actions, quick actions, productivity actions) displayed on the record edit page for specific records.

Action Parameters

action_types
form_factor
record_ids
stringRequired
retrieval_mode

Action Response

data
objectRequired
error
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
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
successful
booleanRequired

Tool Name: Get search layout

Description

Tool to retrieve search result layout configuration for specified Salesforce objects. Use when you need to understand which fields are displayed in global search results.

Action Parameters

object_names
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get search result layouts

Description

Retrieves search result layout information for specified sObjects. Use when you need to understand which fields are displayed in search results for objects.

Action Parameters

object_names
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get approval layouts for object

Description

Retrieves approval layouts for a specified Salesforce object. Use when you need to understand which fields are displayed in approval pages or to dynamically build approval interfaces.

Action Parameters

sobject_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get sObject by external ID

Description

Tool to retrieve a Salesforce record by matching an external ID field value. Use when you need to find a record using a custom external identifier instead of the Salesforce ID. The field specified must be marked as an External ID in Salesforce.

Action Parameters

field_name
stringRequired
field_value
stringRequired
fields
sobject
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get multiple sObject records

Description

Tool to retrieve multiple records of the same sObject type in a single API call. Use when you need to fetch up to 200 records by their IDs. Returns an array of sObjects with the specified fields.

Action Parameters

all_or_none
fields
stringRequired
ids
stringRequired
sobject_type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get sObject list view information

Description

Tool to retrieve basic information about a specific list view for an sObject. Use when you need to get list view metadata including its ID, label, developer name, and URLs for accessing results and detailed descriptions.

Action Parameters

list_view_id
stringRequired
sobject_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get list views for sObject

Description

Tool to retrieve list views for a specified sObject. Use when you need to discover available filtered views of records for objects like Account, Contact, Lead, or Opportunity.

Action Parameters

sobject_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get sObject Quick Action Default Values by ID

Description

Retrieves default field values for a quick action in a specific record context. Use when you need to pre-populate fields when creating related records through quick actions.

Action Parameters

action_name
stringRequired
context_id
stringRequired
sobject
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get sObject Quick Action Default Values

Description

Retrieves default field values for a specific quick action on an sObject. Use when you need to understand what fields will be automatically populated when executing the quick action.

Action Parameters

action_name
stringRequired
sobject
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get sObject record by ID

Description

Tool to retrieve a single Salesforce record by ID from any sObject type. Use when you need to get detailed information about a specific record.

Action Parameters

fields
record_id
stringRequired
sobject_api_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get records using sObject relationships

Description

Retrieves records by traversing sObject relationships using friendly URLs. Use when you need to get related records through a relationship field (e.g., all Contacts for an Account).

Action Parameters

fields
id
stringRequired
relationship_field_name
stringRequired
sobject
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all sObjects

Description

Tool to retrieve list of all available Salesforce objects with metadata. Use when you need to discover which sObjects exist in the organization or check object capabilities.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get layouts for object with record type

Description

Tool to retrieve layout metadata for a specific record type on an object. Use when you need detailed information about page layouts, field positioning, sections, quick actions, related lists, and buttons for a particular record type.

Action Parameters

record_type_id
stringRequired
sobject
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get approval layouts for object

Description

Retrieves approval layout metadata for a specified Salesforce object. Use when you need to understand which fields are displayed during approval processes for a given object type. Available in API version 30.0 and later.

Action Parameters

sobject
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get updated sObject records

Description

Tool to retrieve a list of sObject records that have been updated within a given timeframe. Use when you need to synchronize records or track changes to specific sObject types over a time period.

Action Parameters

end
stringRequired
sobject
stringRequired
start
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get support knowledge

Description

Retrieves the root of the Support Knowledge REST API. Use when you need to access knowledge articles and data category information.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get support knowledge articles

Description

Retrieves user's visible knowledge articles and data categories from Salesforce Knowledge. Use when you need to access published, draft, or archived articles based on user permissions.

Action Parameters

accept_language
stringDefaults to en-US
categories
channel
page_number
page_size
publish_status
sort
topics

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get theme

Description

Tool to get icons and colors for Salesforce UI themes. Use when you need to retrieve theme information for objects in the organization.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get lookup field actions

Description

Tool to get lookup field actions for a Salesforce object. Use when you need to retrieve available actions for lookup fields on a specific object type (e.g., Account, Contact).

Action Parameters

action_types
form_factor
object_api_name
stringDefaults to Account
sections

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get MRU List View Actions

Description

Tool to retrieve header actions available on the MRU (Most Recently Used) list view for a specified Salesforce object. Use when you need to get available actions, buttons, and quick actions for an object's list view.

Action Parameters

action_types
form_factor
object_api_name
stringDefaults to Account

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Personalized Navigation Items

Description

Tool to get personalized navigation items for a specific Salesforce app. Use when you need to retrieve the navigation tabs that a user has access to within an application.

Action Parameters

app_id
stringRequired
form_factor
nav_item_names
page
page_size

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Account AllAccounts list view metadata

Description

Retrieves list view metadata for the Account AllAccounts view using Salesforce UI API. Use when you need to understand the structure, columns, filters, and sorting of the standard AllAccounts list view.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get List View Metadata

Description

Tool to get list view metadata from Salesforce UI API. Use when you need to retrieve configuration details for a list view including columns, filters, sorting, and permissions.

Action Parameters

list_view_api_name
stringDefaults to __Recent
object_api_name
stringDefaults to Account

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Account SearchResult list view metadata

Description

Retrieves list view metadata for the Account __SearchResult view using Salesforce UI API. Use when you need to understand the structure, columns, filters, and sorting of search results for Accounts.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get List Views for Object

Description

Tool to get list views for a Salesforce object. Use when you need to retrieve available list views with options to filter by recent usage and search.

Action Parameters

object_api_name
stringDefaults to Account
page_size
page_token
q
recent_lists_only
booleanDefaults to True

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get lookup field suggestions

Description

Tool to get lookup field suggestions for records. Use when editing lookup fields to search for and display record suggestions based on recent usage, name matching, or full-text search.

Action Parameters

dependent_field_bindings
field_api_name
stringRequired
object_api_name
stringRequired
page
page_size
q
search_type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get MRU List Info for Account

Description

Tool to get Most Recently Used (MRU) list view metadata for Account object. Use when you need to retrieve list view settings, display columns, and preferences. Note: This endpoint is deprecated and no longer updates.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get MRU List Records for Account

Description

Tool to get Most Recently Used (MRU) list view records for Account object. Use when you need to retrieve recently accessed Account records. Note: This endpoint is deprecated and no longer updates. It is not part of the Services under your Main Services Agreement with Salesforce and is for evaluation purposes only, not for production use.

Action Parameters

fields
optional_fields
page_size
page_token
sort_by

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get batch of UI API records

Description

Tool to retrieve multiple Salesforce records in a single request with customizable field selection. Use when you need to fetch data for multiple records at once (up to 200 records).

Action Parameters

fields
optional_fields
record_ids
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get batch of records by IDs

Description

Tool to retrieve multiple Salesforce records in a single API call. Use when you need to fetch data for up to 200 records at once, supporting mixed object types with field-level security.

Action Parameters

fields
optional_fields
record_ids
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get record UI data and metadata

Description

Tool to retrieve layout, field metadata, and record data in a single response. Use when you need comprehensive information including UI layout configuration, object metadata, and actual record values with child relationships.

Action Parameters

child_relationships
form_factor
layout_types
modes
optional_fields
page_size
record_ids
stringRequired

Action Response

data
objectRequired
error
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
successful
booleanRequired

Tool Name: Get user password expiration status

Description

Tool to check whether a Salesforce user's password has expired. Use when you need to verify password expiration status for a specific user.

Action Parameters

user_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get custom actions headers

Description

Tool to return HTTP headers for custom invocable actions without response body. Use when you need to check resource availability and metadata before executing full requests or to validate resource state conditionally.

Action Parameters

if_unmodified_since

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get standard actions headers

Description

Tool to return HTTP headers for standard invocable actions metadata without response body. Use when you need to perform efficient cache validation, check for metadata changes, or reduce bandwidth usage before retrieving full action metadata.

Action Parameters

if_modified_since
if_unmodified_since

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get AppMenu Salesforce1 headers

Description

Tool to return HTTP headers for AppMenu Salesforce1 mobile navigation items without response body. Use when you need to check resource metadata, validate cache (via ETag or Last-Modified), or test endpoint availability without data transfer overhead.

Action Parameters

if_modified_since
if_none_match

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get process rules headers

Description

Tool to return HTTP headers for process rules of an sObject without retrieving the response body. Use when you need to check if process rules exist for an sObject or retrieve metadata like ETag and Last-Modified headers.

Action Parameters

sobject
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Quick Actions headers

Description

Tool to return HTTP headers for Quick Actions resource without response body. Use when you need to inspect metadata before retrieving full Quick Actions content or to validate resource availability.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get quick action default values headers by ID

Description

Tool to return HTTP headers for sObject quick action default values by context ID without response body. Use when you need to check resource availability, verify cache validation headers (ETag, Last-Modified), or optimize API calls by avoiding unnecessary data transfer.

Action Parameters

action_name
stringRequired
context_id
stringRequired
if_modified_since
if_none_match

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get global publisher layouts headers

Description

Tool to return HTTP headers for all global publisher layouts without response body. Use when implementing cache validation strategies, efficient resource polling, or checking if layouts have been modified without transferring layout data.

Action Parameters

if_modified_since
if_none_match

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get sObject quick action headers

Description

Tool to return HTTP headers for a specific sObject quick action without response body. Use when you need to check ETag or Last-Modified headers before fetching full content or to validate quick action availability.

Action Parameters

action_name
stringRequired
if_modified_since
if_none_match
sobject_type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get User password headers

Description

Tool to return HTTP headers for User password resource without response body. Use when you need to check user password metadata and expiration status efficiently without retrieving the full response content.

Action Parameters

user_id
stringRequired

Action Response

data
objectRequired
error
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
successful
booleanRequired

Tool Name: List Analytics templates

Description

Tool to list CRM Analytics templates available in the org. Use when you need to discover available templates for creating Analytics apps.

Action Parameters

options
page
pageSize
type

Action Response

data
objectRequired
error
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
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
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
arrayRequired
error
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
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
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
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
successful
booleanRequired

Tool Name: List pricebook entries

Description

Lists pricebook entries from Salesforce using SOQL query, allowing flexible filtering, sorting, and field selection. Use this to map product names to pricebook entry IDs needed for opportunity line items.

Action Parameters

query
stringDefaults to SELECT Id, Name, Product2Id, Pricebook2Id, UnitPrice, IsActive, ProductCode, Product2.Name FROM PricebookEntry

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List pricebooks

Description

Lists pricebooks from Salesforce using SOQL query, allowing flexible filtering, sorting, and field selection. Use this to map pricebook names to IDs.

Action Parameters

query
stringDefaults to SELECT Id, Name, IsActive, IsStandard, Description FROM Pricebook2

Action Response

data
objectRequired
error
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
successful
booleanRequired

Tool Name: Get list view results

Description

Retrieves detailed information about a list view including column definitions and record data. Use when you need to access list view results with optional pagination controls.

Action Parameters

limit
Defaults to 25
list_view_id
stringRequired
offset
sobject_api_name
stringRequired

Action Response

data
objectRequired
error
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
call_disposition
string
call_duration_seconds
call_type
Defaults to Outbound
comments
string
subject
stringDefaults to Call
what_id
string
who_id
string

Action Response

data
objectRequired
error
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
parent_id
string
related_to_id
stringRequired
status
stringDefaults to 3
subject
stringRequired
text_body
string
to_address
stringRequired

Action Response

data
objectRequired
error
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
successful
booleanRequired

Tool Name: Parameterized search POST

Description

Execute a SOSL search with parameters in request body for flexible querying. Use when you need complex search with multiple object types, field filtering, or advanced control.

Action Parameters

defaultLimit
fields
overallLimit
q
stringRequired
sobjects
spellCorrection
where

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Upsert records using external ID

Description

Tool to upsert up to 200 records using external ID field matching. Use when you need to create or update multiple records efficiently in a single API call based on an external ID field.

Action Parameters

all_or_none
boolean
external_id_field_name
stringRequired
records
arrayRequired
sobject_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Salesforce record fields

Description

Tool to update specific fields in any Salesforce record (sObject) without affecting other fields. Use when you need to perform partial updates on records of any object type including standard objects (Account, Contact, Lead, Opportunity, Case) or custom objects.

Action Parameters

fields
objectRequired
record_id
stringRequired
sobject_type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update record via UI API

Description

Tool to update specific fields in an existing Salesforce record via UI API. Use when you need to modify field values on a record while preserving unchanged fields.

Action Parameters

allow_save_on_duplicate
fields
objectRequired
record_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Execute Composite Graph

Description

Tool to execute multiple related REST API requests in a single transactional call with up to 500 subrequests per graph. Use when you need to perform multiple Salesforce operations atomically where all operations must succeed or fail together. Supports referencing output from one request as input to subsequent requests using @{referenceId.fieldName} syntax.

Action Parameters

graphs
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create records using sObject Collections

Description

Tool to create up to 200 records in one request using sObject Collections. Use when you need to create multiple records of potentially different sObject types efficiently in a single API call.

Action Parameters

all_or_none
boolean
records
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get multiple records by IDs

Description

Retrieves multiple records of the same object type by IDs with a request body. Use when you need to retrieve more records than URL length limits allow (up to 2000 records vs ~800 via GET).

Action Parameters

fields
arrayRequired
ids
arrayRequired
sobject_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create sObject tree records

Description

Tool to create one or more sObject trees with root records of the specified type. Use when creating multiple related records in a single API call (e.g., an Account with multiple Contacts and Opportunities). Supports up to 200 total records across trees with maximum depth of 5 levels. All operations are atomic - if any record fails, no records are created.

Action Parameters

records
arrayRequired
sobject_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Parameterized Search

Description

Tool to execute parameterized search across Salesforce objects with advanced filtering. Use when you need to search for records using specific search terms with fine-grained control over which objects to search, which fields to return, and additional filtering criteria.

Action Parameters

defaultLimit
fields
in
overallLimit
q
stringRequired
sobjects
spellCorrection
where

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Execute sObject Quick Action

Description

Tool to execute a specific quick action on an sObject to create records with pre-configured defaults. Use when you need to leverage Salesforce Quick Actions to streamline record creation with field mappings and default values.

Action Parameters

action_name
stringRequired
context_id
record
objectRequired
sobject
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create or update record by external ID

Description

Tool to create or update a single record using external ID field matching. Use when you need to upsert a record based on an external ID field value.

Action Parameters

external_id_field_name
stringRequired
external_id_value
stringRequired
record_data
objectRequired
sobject_type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get lookup field suggestions with POST

Description

Tool to get lookup field suggestions with POST request. Use when editing lookup fields with dependent lookup filtering or when you need to pass source record context in the request body.

Action Parameters

dependentFieldBindings
field_api_name
stringRequired
object_api_name
stringRequired
page
page_size
q
search_type
sourceRecord
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get lookup field suggestions with POST

Description

Tool to get lookup field suggestions with POST request. Use when editing lookup fields with dependent lookup filtering or when you need to pass source record context in the request body.

Action Parameters

dependentFieldBindings
field_api_name
stringRequired
object_api_name
stringRequired
page
page_size
q
requestParams
searchTerm
search_type
sourceRecord
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create record via UI API

Description

Tool to create a new record in Salesforce using the UI API. Use when you need to create records with field-level security and sharing rules enforced, with formatted and localized field values returned.

Action Parameters

allow_save_on_duplicate
api_name
stringRequired
fields
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get related list records with request body

Description

Tool to retrieve related list records with request body parameters for filtering and pagination. Use when you need to get records from a related list associated with a parent record with complex query parameters. Returns up to 1,999 records per related list with pagination support.

Action Parameters

fields
optional_fields
page_size
page_token
parent_record_id
stringRequired
related_list_id
stringRequired
sort_by
where

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Execute SOQL Query

Description

Tool to execute SOQL queries against Salesforce. Use when you need to retrieve data from Salesforce objects using SOQL syntax. Returns up to 2000 records per request with pagination support via nextRecordsUrl.

Action Parameters

q
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Query All (including deleted)

Description

Tool to execute SOQL queries including soft-deleted and archived records. Use when you need to query records that have been deleted via merge or delete operations, or when accessing archived Task and Event records.

Action Parameters

query
stringRequired

Action Response

data
objectRequired
error
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
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
allowedInCustomDetailFormula
buckets
chart
crossFilters
currency
customDetailFormula
customSummaryFormula
detailColumns
developerName
division
folderId
groupingsAcross
groupingsDown
hasDetailRows
booleanDefaults to True
hasRecordCount
booleanDefaults to True
historicalSnapshotDates
id
stringRequired
name
presentationOptions
reportBooleanFilter
reportFilters
reportFormat
stringRequired
reportType
objectRequired
scope
showGrandTotal
booleanDefaults to True
showSubtotals
booleanDefaults to True
sortBy
standardDateFilter
standardFilters
topRows
userOrHierarchyFilterId

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get quick actions

Description

Tool to retrieve global and object-specific quick actions from Salesforce. Use when you need to list all available quick actions in the organization.

Action Parameters

Action Response

data
objectRequired
error
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
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
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
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
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
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
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
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
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
successful
booleanRequired

Tool Name: Retrieve lead by id

Description

Retrieves details for a Salesforce Lead by its ID; the specified Lead ID must exist in Salesforce.

Action Parameters

fields
id
stringRequired

Action Response

data
objectRequired
error
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
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
successful
booleanRequired

Tool Name: Retrieve opportunities data

Description

Retrieves all available Opportunity records, representing potential revenue-generating deals, from Salesforce.

Action Parameters

Action Response

data
objectRequired
error
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
id
stringRequired

Action Response

data
objectRequired
error
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
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Retrieve specific contact by id

Description

Retrieves a Salesforce Contact by its unique ID; the ID must correspond to an existing Contact record in Salesforce.

Action Parameters

fields
id
stringRequired

Action Response

data
objectRequired
error
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
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
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
billing_country
billing_state
fields
stringDefaults to Id,Name,Type,Industry,Phone,Website,BillingStreet,BillingCity,BillingState,BillingCountry,NumberOfEmployees,AnnualRevenue
industry
limit
integerDefaults to 50
name
phone
type
website

Action Response

data
objectRequired
error
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
limit
integerDefaults to 50
name
start_date_from
start_date_to
status
type

Action Response

data
objectRequired
error
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
email
fields
stringDefaults to Id,Name,FirstName,LastName,Email,Phone,MobilePhone,Title,AccountId,Account.Name
limit
integerDefaults to 50
name
phone
title

Action Response

data
objectRequired
error
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
email
fields
stringDefaults to Id,Name,FirstName,LastName,Email,Phone,Title,Company,Status,LeadSource,CreatedDate
lead_source
limit
integerDefaults to 50
name
phone
status
title

Action Response

data
objectRequired
error
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
created_date_from
created_date_to
fields
stringDefaults to Id,Title,Body,ParentId,Parent.Name,OwnerId,Owner.Name,IsPrivate,CreatedDate,LastModifiedDate
is_private
limit
integerDefaults to 50
owner_name
parent_name
title

Action Response

data
objectRequired
error
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
amount_max
amount_min
close_date_from
close_date_to
fields
stringDefaults to Id,Name,AccountId,Account.Name,StageName,Amount,CloseDate,IsClosed,IsWon,Probability,LeadSource,CreatedDate
is_closed
is_won
lead_source
limit
integerDefaults to 50
name
stage_name

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get search result layouts

Description

Retrieves search result layout information for specified Salesforce objects. Returns the list of fields displayed as columns, row limits, and labels for each object's search results page.

Action Parameters

object_names
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search suggested queries

Description

Returns a list of suggested searches based on the user's query string. Use when you want to help users discover relevant search terms before performing a search.

Action Parameters

channel
stringRequired
language
stringRequired
q
stringRequired
sobject

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search suggested article title matches

Description

Search for Salesforce Knowledge articles with titles matching the search query. Returns auto-suggest results for Knowledge articles based on title matches.

Action Parameters

channel
language
limit
publishStatus
q
stringRequired
topics
validationStatus

Action Response

data
objectRequired
error
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
activity_date_from
activity_date_to
assigned_to_name
contact_name
fields
stringDefaults to Id,Subject,Status,Priority,ActivityDate,IsClosed,Description,OwnerId,Owner.Name,WhatId,What.Name,WhoId,Who.Name
is_closed
limit
integerDefaults to 50
priority
status
subject

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Send email

Description

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

Action Parameters

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

Action Response

data
objectRequired
error
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
attachment_ids
bcc_addresses
cc_addresses
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
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
successful
booleanRequired

Tool Name: Set user password

Description

Tool to set or reset a user's password in Salesforce. Use when you need to assign a specific password or generate a random one for a user.

Action Parameters

new_password
user_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get approval layouts for sObject

Description

Tool to retrieve approval layouts for a specified Salesforce sObject. Use when you need to understand the approval process structure, fields, and layout configuration for an object. Available in REST API version 30.0 and later.

Action Parameters

approval_process_name
sobject_api_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create multiple records (SObject Collections)

Description

Tool to create up to 200 records in one request with optional rollback. Use when you need to create multiple records of potentially different sObject types efficiently, reducing round-trips between client and server.

Action Parameters

all_or_none
boolean
records
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete multiple records (SObject Collections)

Description

Tool to delete up to 200 records in one request with optional rollback. Use when you need to delete multiple records efficiently, reducing API calls.

Action Parameters

all_or_none
boolean
ids
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get PlatformAction SObject metadata

Description

Retrieves metadata description of PlatformAction SObject. Use when you need to understand the structure and fields of PlatformAction for querying UI actions.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete sObject record

Description

Tool to delete a record using the sObject Rows resource. Use when you need to permanently remove a specific record from Salesforce. A successful delete returns a 204 No Content status.

Action Parameters

record_id
stringRequired
sobject_api_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update sObject record

Description

Tool to update specific fields in an existing Salesforce sObject record. Use when you need to modify one or more fields in a record without affecting other fields.

Action Parameters

fields
objectRequired
record_id
stringRequired
sobject_api_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create sObject tree

Description

Tool to create one or more sObject trees with root records of the specified type. Use when creating nested parent-child record hierarchies in a single atomic operation (e.g., Account with Contacts and Opportunities). Supports up to 200 total records across all trees, up to 5 levels deep, with maximum 5 different object types. All records succeed or all fail together.

Action Parameters

records
arrayRequired
sobject_api_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get user password status

Description

Tool to retrieve password expiration status for a Salesforce user. Use when you need to check if a user's password has expired before performing API operations.

Action Parameters

user_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get standard invocable actions

Description

Retrieves the list of standard actions that can be statically invoked. Use when you need to discover available standard invocable actions like posting to Chatter, sending email, or sending custom notifications.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Execute Tooling API query

Description

Tool to execute SOQL queries against Salesforce Tooling API metadata objects. Use when you need to query metadata components like ApexClass, ApexTrigger, ValidationRule, WorkflowRule, FieldDefinition, or EntityDefinition. The Tooling API exposes objects that use the external object framework and provides granular access to metadata components for development and deployment tasks.

Action Parameters

query
stringRequired

Action Response

data
objectRequired
error
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
billing_city
string
billing_country
string
billing_postal_code
string
billing_state
string
billing_street
string
custom_fields
description
string
fax
string
industry
string
name
string
number_of_employees
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
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
AccountSource
Active__c
AnnualRevenue
BillingCity
BillingCountry
BillingGeocodeAccuracy
BillingLatitude
BillingLongitude
BillingPostalCode
BillingState
BillingStreet
CleanStatus
CreatedById
CreatedDate
CustomerPriority__c
DandbCompanyId
Description
DunsNumber
Fax
Industry
IsDeleted
Jigsaw
JigsawCompanyId
LastActivityDate
LastModifiedById
LastModifiedDate
LastReferencedDate
LastViewedDate
MasterRecordId
NaicsCode
NaicsDesc
Name
NumberOfEmployees
NumberofLocations__c
OperatingHoursId
OwnerId
Ownership
ParentId
Phone
PhotoUrl
Rating
SLAExpirationDate__c
SLASerialNumber__c
SLA__c
ShippingCity
ShippingCountry
ShippingGeocodeAccuracy
ShippingLatitude
ShippingLongitude
ShippingPostalCode
ShippingState
ShippingStreet
Sic
SicDesc
Site
SystemModstamp
TickerSymbol
Tradestyle
Type
UpsellOpportunity__c
Website
YearStarted
attributes__type
attributes__url
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a favorite

Description

Tool to update a favorite's properties in Salesforce UI API. Use when you need to reorder favorites or modify their display properties.

Action Parameters

favorite_id
stringRequired
name
sort_order

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a record

Description

Tool to update a record's data in Salesforce via UI API. Use when you need to modify field values on an existing record. Salesforce validation rules are enforced. Pass If-Unmodified-Since header to prevent conflicts.

Action Parameters

allow_save_on_duplicate
api_name
fields
objectRequired
if_unmodified_since
record_id
stringRequired
trigger_other_email
trigger_user_email
use_default_rule

Action Response

data
objectRequired
error
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
custom_fields
description
string
end_date
string
expected_response
numberDefaults to -1
expected_revenue
numberDefaults to -1
is_active
name
string
number_sent
numberDefaults to -1
parent_id
string
start_date
string
status
string
type
string

Action Response

data
objectRequired
error
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
AmountAllOpportunities
AmountWonOpportunities
BudgetedCost
CampaignMemberRecordTypeId
CreatedById
CreatedDate
Description
EndDate
ExpectedResponse
ExpectedRevenue
IsActive
IsDeleted
LastActivityDate
LastModifiedById
LastModifiedDate
LastReferencedDate
LastViewedDate
Name
NumberOfContacts
NumberOfConvertedLeads
NumberOfLeads
NumberOfOpportunities
NumberOfResponses
NumberOfWonOpportunities
NumberSent
OwnerId
ParentId
StartDate
Status
SystemModstamp
Type
attributes__type
attributes__url
id
stringRequired

Action Response

data
objectRequired
error
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
custom_fields
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
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
AssistantName
AssistantPhone
Birthdate
CleanStatus
ContactSource
CreatedById
CreatedDate
Department
Description
Email
EmailBouncedDate
EmailBouncedReason
Fax
FirstName
HomePhone
IndividualId
IsDeleted
IsEmailBounced
IsPriorityRecord
Jigsaw
JigsawContactId
Languages__c
LastActivityDate
LastCURequestDate
LastCUUpdateDate
LastModifiedById
LastModifiedDate
LastName
LastReferencedDate
LastViewedDate
LeadSource
Level__c
MailingCity
MailingCountry
MailingGeocodeAccuracy
MailingLatitude
MailingLongitude
MailingPostalCode
MailingState
MailingStreet
MasterRecordId
MobilePhone
Name
OtherCity
OtherCountry
OtherGeocodeAccuracy
OtherLatitude
OtherLongitude
OtherPhone
OtherPostalCode
OtherState
OtherStreet
OwnerId
Phone
PhotoUrl
ReportsToId
Salutation
SystemModstamp
Title
attributes__type
attributes__url
id
stringRequired

Action Response

data
objectRequired
error
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
custom_fields
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
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
City
CleanStatus
Company
CompanyDunsNumber
ConvertedAccountId
ConvertedContactId
ConvertedDate
ConvertedOpportunityId
Country
CreatedById
CreatedDate
CurrentGenerators__c
DandbCompanyId
Description
Email
EmailBouncedDate
EmailBouncedReason
Fax
FirstName
GeocodeAccuracy
IndividualId
Industry
IsConverted
IsDeleted
IsPriorityRecord
IsUnreadByOwner
Jigsaw
JigsawContactId
LastActivityDate
LastModifiedById
LastModifiedDate
LastName
LastReferencedDate
LastViewedDate
Latitude
LeadSource
Longitude
MasterRecordId
MobilePhone
Name
NumberOfEmployees
NumberofLocations__c
OwnerId
Phone
PhotoUrl
PostalCode
Primary__c
ProductInterest__c
Rating
SICCode__c
Salutation
State
Status
Street
SystemModstamp
Title
Website
attributes__type
attributes__url
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update list view preferences

Description

Tool to update user preferences for a Salesforce list view including column widths, text wrapping, and display order. Use when you need to customize how columns appear in a list view.

Action Parameters

column_order
column_widths
column_wrap
list_view_api_name
stringRequired
object_api_name
stringRequired

Action Response

data
objectRequired
error
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
custom_fields
is_private
note_id
stringRequired
owner_id
string
title
string

Action Response

data
objectRequired
error
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
custom_fields
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
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
Amount
CampaignId
CloseDate
ContactId
CreatedById
CreatedDate
CurrentGenerators__c
DeliveryInstallationStatus__c
Description
ExpectedRevenue
Fiscal
FiscalQuarter
FiscalYear
ForecastCategory
ForecastCategoryName
HasOpenActivity
HasOpportunityLineItem
HasOverdueTask
IsClosed
IsDeleted
IsPrivate
IsWon
LastActivityDate
LastAmountChangedHistoryId
LastCloseDateChangedHistoryId
LastModifiedById
LastModifiedDate
LastReferencedDate
LastStageChangeDate
LastViewedDate
LeadSource
MainCompetitors__c
Name
NextStep
OrderNumber__c
OwnerId
Pricebook2Id
Probability
PushCount
StageName
SystemModstamp
TotalOpportunityQuantity
TrackingNumber__c
Type
attributes__type
attributes__url
id
stringRequired

Action Response

data
objectRequired
error
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
CreatedById
CreatedDate
IsDeleted
IsPrivate
LastModifiedById
LastModifiedDate
OwnerId
ParentId
SystemModstamp
Title
attributes__type
attributes__url
id
stringRequired

Action Response

data
objectRequired
error
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
custom_fields
description
string
is_reminder_set
priority
string
reminder_date_time
status
string
subject
string
task_id
stringRequired
what_id
string
who_id
string

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Upload file to Salesforce Files

Description

Upload a file to Salesforce Files home via the Connect REST API. Use when you need to attach files to records or store them in a user's personal library. File size limit: 50 MB per request.

Action Parameters

content_b64
desc
file
filename
first_publish_location_id
mimetype_override
title

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Upload job data

Description

Tool to upload CSV data to a Salesforce Bulk API v2 ingest job. Use after creating a job and before closing it. Only ONE upload is allowed per job - multiple uploads will fail. After upload, close the job with state 'UploadComplete' to begin processing.

Action Parameters

csv_data
stringRequired
job_id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Upsert sObject by External ID

Description

Tool to upsert records using sObject Rows by External ID. Use when you need to create or update a Salesforce record based on an external ID field value - creates a new record if the external ID doesn't exist, or updates the existing record if it does.

Action Parameters

field_name
stringRequired
field_value
stringRequired
fields
objectRequired
sobject
stringRequired
update_only

Action Response

data
objectRequired
error
successful
booleanRequired