Salesforce is a leading CRM platform integrating sales, service, marketing, and analytics to build customer relationships and drive business growth
Salesforce is a leading CRM platform integrating sales, service, marketing, and analytics to build customer relationships and drive business growth On Nagent, Salesforce is exposed as a fully-configurable crm integration that any agent can call — 216 actions, 7 triggers, and OAUTH2, S2S_OAUTH2 authentication. No code is required to wire Salesforce into your workflow — connect it once via the External Integrations panel and reuse it across every agent you build.
Agent builders use Salesforce to automate the kinds of tasks crm teams previously handled manually. Concrete examples — each one is a single agent step in Nagent — include:
Salesforce also supports 4 event triggers ("Account Created or Updated", "Contact Updated", "Record Updated (Generic SObject)", and more), which lets your Nagent agents react to Salesforce activity in real time — for example, kicking off a downstream workflow the moment a relevant event fires.
Every action and trigger is paired with a structured input/output schema (visible in the sections below), so when you wire Salesforce into Helix — our agentic agent builder — the editor knows exactly what each step expects and produces. Configure once, deploy anywhere across your Nagent agents.
Triggers are the entry points of agents built on Nagent — pick one to fire your agent the moment a Salesforce event happens. Webhook triggers run instantly; poll triggers check on an interval you configure. Each shows its configuration parameters and the payload your agent receives.
SALESFORCE_ACCOUNT_CREATED_OR_UPDATED_TRIGGERTriggers when an Account is created or updated in Salesforce. Uses LastModifiedDate high-watermark to capture both creations and updates.
Configuration
Optional additional SOQL filter to AND with LastModifiedDate condition. Example: Industry = 'Technology'
Optional list of Account fields to include in the payload. If not provided, a set of common key fields is returned.
Periodic Interval to Check for Updates & Send a Trigger in Minutes
Maximum number of accounts to check in each poll (1-1000)
Payload
The Account record
Type of Salesforce Account event
SALESFORCE_CONTACT_UPDATED_TRIGGERTriggers when an existing Salesforce Contact record is modified. Emits changed fields alongside relevant timestamps.
Configuration
List of Contact fields to monitor for changes. Only changes in these fields will be emitted in the payload.
Periodic Interval to Check for Updates & Send a Trigger in Minutes
Maximum number of updated contacts to fetch per poll (LIMIT).
Payload
Mapping of field name to {old, new} values
The ID of the updated contact
Type of event
LastModifiedDate timestamp of the record
SystemModstamp timestamp of the record
SALESFORCE_GENERIC_S_OBJECT_RECORD_UPDATED_TRIGGERTriggers when monitored fields change on any Salesforce SObject. You specify the SObject type and which field values should be returned in the payload. The trigger uses SystemModstamp to detect changes regardless of which specific field changed.
Configuration
List of field API names to include in the payload when a record is updated. If omitted, only metadata like Id, SystemModstamp, and LastModifiedDate will be returned.
Optional SOQL filter expression to further restrict which records to monitor. Example: OwnerId = '005XXXXXXXXXXXX' AND IsDeleted = false
Periodic Interval to Check for Updates & Send a Trigger in Minutes
Maximum number of records to fetch per poll (1-2000).
The API name of the Salesforce SObject to monitor (e.g., Account, Contact, Lead)
Payload
Type of event emitted for the generic SObject update
The record ID
LastModifiedDate value of the record at the time of update
A dictionary of monitored field values at the time of the update
The SObject type that was updated
SystemModstamp value of the record at the time of update
SALESFORCE_NEW_CONTACT_TRIGGERTriggers when a new Contact is Created in Salesforce.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
Payload
The Salesforce contact that was created
Type of Salesforce contact event
SALESFORCE_NEW_LEAD_TRIGGERTriggers when a new Lead is created in Salesforce.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
Payload
Type of Salesforce lead event
The Salesforce lead that was created
SALESFORCE_NEW_OR_UPDATED_OPPORTUNITY_TRIGGERTriggers when a Salesforce Opportunity is created or updated.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
Maximum number of records to fetch per poll (1-2000).
Optional StageName to filter opportunities by. When provided, only opportunities with this StageName will be returned.
Payload
Type of Salesforce opportunity event
The Salesforce Opportunity that was created or updated
SALESFORCE_TASK_CREATED_OR_COMPLETED_TRIGGERTriggers when a Task is created or when its status changes to Completed in Salesforce. Supports optional filtering by task Status or Subject.
Configuration
Periodic Interval to Check for Updates & Send a Trigger in Minutes
Maximum number of tasks to retrieve per poll
Filter tasks by exact Status (e.g., 'Not Started', 'In Progress', 'Completed')
Filter tasks where Subject contains this text (partial match)
Payload
Type of event: 'task_created' or 'task_completed'
The Salesforce task involved in the event
Every operation an agent can call against Salesforce, with input parameters and output schema. Drop these into any step of an agent built in Helix.
SALESFORCE_ACCOUNT_CREATION_WITH_CONTENT_TYPE_OPTIONDEPRECATED: Creates a new Salesforce Account using a JSON POST request, requiring 'Name'; specific fields (e.g., custom, DunsNumber) may have org-level prerequisites.
Input parameters
Unique identifier for the account (system-generated and read-only upon creation).
Fax number for the account.
Standard Industrial Classification (SIC) code (max 20 chars). For business accounts only.
Name of the account (required, max 255 chars). For Person Accounts, this is a concatenated field from the associated contact and not directly modifiable.
Name of the account’s specific location or site (max 80 chars).
Type of account, influencing categorization and behavior.
Primary phone number for the account (max 40 chars).
Data.com company ID reference (max 20 chars, API v22.0+). For business accounts. Read-only, do not modify.
Prospect rating (picklist).
Custom field for Service Level Agreement (SLA) type/details.
ID of the Salesforce user owning this account. 'Transfer Record' permission may be needed to update if not the API user (API v16.0+).
Description of line of business based on SIC code (max 80 chars). For business accounts only.
Website URL of the account (max 255 chars).
Primary industry of the account (picklist, max 40 chars).
ID of the parent account for subsidiary or hierarchical relationships.
URL path for the social network profile image (read-only). Blank if Social Accounts and Contacts is not enabled for the user.
Custom field indicating if the account is active.
Indicates if the account is in the Recycle Bin (read-only).
NAICS code (6-digit industry classifier, max 8 chars). For business accounts. Requires Data.com Prospector/Clean.
Description of line of business based on NAICS code (max 120 chars). For business accounts. Requires Data.com Prospector/Clean.
Ownership structure (picklist).
D-U-N-S number (9-digit identifier, max 9 chars). For business accounts. Requires Data.com Prospector/Clean.
Organization's 'Doing Business As' (DBA) name (max 255 chars). For business accounts. Requires Data.com Prospector/Clean.
City for the billing address (max 40 chars).
Data quality status compared with Data.com.
ID of the user who created the account (read-only).
Date and time of account creation (read-only).
Text description of the account (max 32,000 chars).
Year the organization was established (max 4 chars). For business accounts. Requires Data.com Prospector/Clean.
State or province for the billing address (max 80 chars).
City for the shipping address (max 40 chars).
Stock market ticker symbol (max 20 chars). For business accounts only.
Account number assigned to this account (max 40 chars).
Origin source of the account record (admin-defined picklist, values max 40 chars).
Estimated annual revenue.
Street address for the billing location.
State or province for the shipping address (max 80 chars).
Dictionary of custom field API names and their values. Custom field names typically end with '__c'.
Country for the billing address (max 80 chars).
Associated Dun & Bradstreet company ID for D&B integration (read-only).
Timestamp of when current user last viewed this account record (read-only).
ID of the master record if this account was merged (read-only).
Street address for the shipping location (max 255 chars).
Timestamp of last modification by user or automated process (read-only).
Latitude for the billing address (-90 to 90, up to 15 decimal places).
Associated Data.com company ID (read-only).
Country for the shipping address (max 80 chars).
Internal Salesforce field: Relative API URL for this SObject record. System-set or read-only.
Longitude for the billing address (-180 to 180, up to 15 decimal places).
Most recent due date of an event or closed task associated with the record (read-only).
ID of the user who last modified the account (read-only).
Date and time of last modification (read-only).
ID of associated operating hours. Requires Salesforce Field Service.
Latitude for the shipping address (-90 to 90, up to 15 decimal places).
Internal Salesforce field: Type of the SObject (e.g., 'Account'). System-set or read-only.
Postal code for the billing address (max 20 chars).
Number of employees (max 8 digits).
Longitude for the shipping address (-180 to 180, up to 15 decimal places).
Timestamp of when current user last accessed this record or related items (read-only).
Custom field for SLA serial number.
Postal code for the shipping address (max 20 chars).
Custom field for customer priority (e.g., High, Medium, Low).
Custom field for the number of physical locations.
Custom field for SLA expiration date.
Custom field indicating upsell opportunity potential.
Accuracy level of the geocode for the billing address.
Accuracy level of the geocode for the shipping address.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_ADD_CONTACT_TO_CAMPAIGNAdds a contact to a campaign by creating a CampaignMember record to track campaign engagement. Fails if the contact is already a member of the campaign; pre-check membership via SOQL before calling.
Input parameters
The status of the campaign member. Common values include 'Sent', 'Responded'. The available statuses depend on campaign configuration. Value must exactly match a configured CampaignMember Status for the campaign; arbitrary strings will fail. Query the campaign's CampaignMemberStatus records first if unsure of valid values.
The Salesforce ID of the contact to add to the campaign.
The Salesforce ID of the campaign to add the contact to.
Dictionary of custom field API names and their values for CampaignMember. Custom field names typically end with '__c'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_ADD_LEAD_TO_CAMPAIGNAdds a lead to a campaign by creating a CampaignMember record, allowing you to track campaign engagement. Both `campaign_id` and `lead_id` must be valid Salesforce IDs of active, existing records — names or emails cannot be substituted, and deleted or inactive records will cause the call to fail. This is a persistent CRM write; confirm the correct lead and campaign before calling.
Input parameters
The status of the campaign member. Common values include 'Sent', 'Responded'. The available statuses depend on campaign configuration. Value must exactly match one of the campaign's configured CampaignMember statuses; a mismatch will cause the call to be rejected.
The Salesforce ID of the lead to add to the campaign.
The Salesforce ID of the campaign to add the lead to.
Dictionary of custom field API names and their values for CampaignMember. Custom field names typically end with '__c'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_ADD_OPPORTUNITY_LINE_ITEMAdds a product (line item) to an opportunity. The product must exist in a pricebook entry that's associated with the opportunity's pricebook.
Input parameters
Discount percentage (0-100). Cannot be used with TotalPrice.
The quantity of the product to add.
The sales price per unit. If not specified, uses the standard price from the pricebook entry.
Optional description for this line item.
The total price for this line item. Cannot be used with UnitPrice or Discount.
Service date for the product in YYYY-MM-DD format.
Dictionary of custom field API names and their values. Custom field names typically end with '__c'.
The Salesforce ID of the opportunity to add a product to.
The ID of the PricebookEntry that contains the product and price information. This links to a specific product in a specific pricebook. Entry must be active and match the opportunity's pricebook and currency; mismatches cause REQUIRED_FIELD_MISSING or INVALID_CROSS_REFERENCE_KEY errors. Use SALESFORCE_LIST_PRICEBOOK_ENTRIES to find valid entries.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_APPLY_LEAD_ASSIGNMENT_RULESApplies configured lead assignment rules to a specific lead, automatically routing it to the appropriate owner based on your organization's rules. Allow a brief propagation delay before querying updated ownership or field values after rule application.
Input parameters
The Salesforce ID of the lead to apply assignment rules to.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_ASSOCIATE_CONTACT_TO_ACCOUNTAssociates a contact with an account by updating the contact's AccountId field. Overwrites any existing AccountId on the contact. For broader contact field updates alongside the account association, use SALESFORCE_UPDATE_CONTACT instead.
Input parameters
The Salesforce ID of the account to associate the contact with.
The Salesforce ID of the contact to associate with an account.
Dictionary of custom field API names and their values to update on the contact. Custom field names typically end with '__c'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CLONE_OPPORTUNITY_WITH_PRODUCTSClones an opportunity and optionally its products (line items). Creates a new opportunity with the same field values and products as the original.
Input parameters
Name for the cloned opportunity. If not specified, will append 'Clone of' to original name.
Close date for the cloned opportunity in YYYY-MM-DD format. If not specified, uses original close date.
Stage for the cloned opportunity. If not specified, uses original stage.
Whether to clone the opportunity's products (line items). Set to false to clone only the opportunity.
The ID of the opportunity to clone.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CLONE_RECORDCreates 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.
Input parameters
The ID of the record to clone.
The Salesforce object type to clone (e.g., Account, Contact, Lead, Opportunity).
Optional field updates to apply to the cloned record as a JSON string. Use this to modify specific fields in the clone. Example: '{"Name": "Clone of Original", "Status": "New"}'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CLOSE_OR_ABORT_JOBTool 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.
Input parameters
The state to update the job to. 'UploadComplete' closes the job and queues uploaded data for processing. 'Aborted' cancels the job and deletes any uploaded data. This field is required.
The unique identifier of the Bulk API v2 ingest job to close or abort.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_COMPLETE_TASKMarks a task as completed with optional completion notes. This is a convenience action that updates the task status to 'Completed'.
Input parameters
The Salesforce ID of the task to mark as completed.
Dictionary of custom field API names and their values. Custom field names typically end with '__c' (e.g., 'Completion_Source__c').
Optional notes to add about the task completion. Will be appended to existing description.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_COMPOSITE_GRAPH_ACTIONDEPRECATED: Use SALESFORCE_POST_COMPOSITE_GRAPH instead. 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.
Input parameters
Array of graph objects to execute. Each graph is transactional. Multiple graphs can be submitted in one request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_ACCOUNTCreates a new account in Salesforce with the specified information. Returns the created Account's ID at `data.response_data.id`.
Input parameters
Fax number.
Account name (required field in Salesforce).
Type of account.
Main phone number.
Company website URL.
Industry the account belongs to.
Standard Industrial Classification (SIC) description.
ID of the parent account if this is a subsidiary. Must be a valid Salesforce Account Id (15- or 18-character).
Text description of the account.
Billing address city.
Billing address state/province. For US/Canada addresses, use full state/province names (e.g., 'California', 'New York', 'Ontario') or abbreviations ('CA', 'NY') which are auto-converted. For other countries, leave empty unless you know the exact valid picklist value for your Salesforce org. WARNING: If State/Country Picklists are enabled in your org, only pre-configured values are accepted; arbitrary region names will be rejected with FIELD_INTEGRITY_EXCEPTION.
Custom fields to set on the account. Use Salesforce API field names (e.g., 'Level__c', 'Languages__c'). Values can be strings, numbers, booleans, or null.
Shipping address city.
Source of the account.
Estimated annual revenue.
Billing address street.
Shipping address state/province. For US/Canada addresses, use full state/province names (e.g., 'California', 'New York', 'Ontario') or abbreviations ('CA', 'NY') which are auto-converted. For other countries, leave empty unless you know the exact valid picklist value for your Salesforce org. WARNING: If State/Country Picklists are enabled in your org, only pre-configured values are accepted; arbitrary region names will be rejected with FIELD_INTEGRITY_EXCEPTION.
Billing address country.
Shipping address street.
Shipping address country.
Billing address postal/zip code.
Number of employees.
Shipping address postal/zip code.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_A_RECORDTool 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.
Input parameters
Dictionary mapping field API names to their values. Keys are field API names (e.g., 'Name', 'FirstName', 'AccountId') and values are the data to set for those fields. Custom fields (ending in '__c') should be passed as direct key-value pairs, not nested under a 'CustomFields' key.
The API name of the Salesforce object to create (e.g., 'Account', 'Contact', 'Opportunity', 'ContentNote').
Controls whether to allow saving when duplicates are detected. Note: Not currently supported in Lightning Web Components createRecord function.
Internal message about input processing performed during execution.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_CAMPAIGNCreates a new campaign in Salesforce. Only `name` is universally required, but org-level validation rules commonly enforce `type`, `status`, `start_date`, and `end_date` as well — omitting them may cause creation to fail.
Input parameters
Campaign name (required field in Salesforce).
Type of campaign.
Current status of the campaign.
Campaign end date in YYYY-MM-DD format.
Whether the campaign is currently active. Depending on org configuration, setting to `true` may require valid `start_date`/`end_date` ranges; violations raise a non-retriable `CANNOT_INSERT_UPDATE_ACTIVATE_ENTITY` error.
ID of the parent campaign if this is a child campaign.
Campaign start date in YYYY-MM-DD format.
Actual cost spent on the campaign.
Detailed description of the campaign.
Number of individuals targeted by the campaign.
Budgeted cost for the campaign.
Dictionary of custom field names and their values. Custom field names should end with '__c' (e.g., 'Priority__c', 'Region__c'). Values can be strings, numbers, booleans, or dates depending on the field type.
Expected revenue from the campaign.
Expected response rate as a percentage.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_CAMPAIGN_RECORD_VIA_POSTDEPRECATED: 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.
Input parameters
Unique identifier for the campaign record, usually system-generated upon creation.
Required. Name of the campaign (limit 80 characters).
Type of campaign (limit 40 characters).
Current status of the campaign (limit 40 characters).
Ending date for the campaign (YYYY-MM-DD); responses received after this date are still counted.
ID of the campaign owner. Defaults to the ID of the user making the API call.
Indicates if the campaign is active. Label: Active.
ID of the parent Campaign record for hierarchical grouping.
Indicates if the campaign record has been deleted.
Starting date for the campaign (YYYY-MM-DD).
Actual cost of the campaign, in the organization's currency.
Total number of individuals targeted (e.g., emails sent). Label: Num Sent.
Read-only. ID of the user who created this campaign record.
Read-only. Creation date and time (ISO 8601).
Detailed description of the campaign (limit 32KB; first 255 characters displayed in reports).
Budgeted cost for this campaign, in the organization's currency.
Read-only. Total leads associated with this campaign. Label: Leads in Campaign.
Dictionary of custom field API names and their values. Custom field names typically end with '__c'.
Read-only. Timestamp of current user's last view of this record/list view (ISO 8601). Null if only accessed (see LastReferencedDate) but not viewed.
Read-only. Last modification date and time by a user or automated process (ISO 8601).
Expected revenue from this campaign, in the organization's currency.
Read-only. Relative URL to the campaign record.
Percentage of responses expected from targeted individuals.
Read-only. Most recent activity date (event due date or closed task due date, YYYY-MM-DD).
Read-only. ID of the user who last modified this campaign record.
Read-only. Last modification date and time (ISO 8601).
Read-only. Total contacts associated with this campaign. Label: Total Contacts.
sObject type, typically 'Campaign'.
Read-only. Contacts and unconverted leads with Member Status “Responded”. Label: Responses in Campaign.
Read-only. Timestamp of current user's last access to this record, a related record, or a list view (ISO 8601).
Read-only. Total opportunities associated with this campaign. Label: Opportunities in Campaign.
Read-only. Total monetary amount of all opportunities (including closed/won) in this campaign, in organization's currency. Label: Value Opportunities in Campaign.
Read-only. Total monetary amount of closed/won opportunities in this campaign, in organization's currency. Label: Value Won Opportunities in Campaign.
Read-only. Leads converted to an account and contact from this campaign. Label: Converted Leads.
Read-only. Closed or won opportunities from this campaign. Label: Won Opportunities in Campaign.
Record type ID for associated CampaignMember records, determining their fields and layout.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_CONTACTCreates a new contact in Salesforce with the specified information. Writes to live CRM data — obtain explicit user confirmation before executing. Failures may reflect org-specific validation rules, permission restrictions, or duplicate rules rather than invalid inputs.
Input parameters
Contact's email address.
Contact's primary phone number.
Contact's job title.
Contact's birthdate in YYYY-MM-DD format.
Contact's last name (required field in Salesforce).
ID of the Account this contact is associated with.
Contact's department.
Contact's first name.
Source from which this contact originated.
Contact's mailing city.
Contact's mobile phone number.
Dictionary of custom field API names and their values. Custom field names typically end with '__c' (e.g., 'Level__c', 'Languages__c').
Contact's mailing state/province.
Contact's mailing street address.
Contact's mailing country.
Contact's mailing postal/zip code.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_CUSTOM_FIELDTool to create a custom field on a Salesforce object using the Tooling API. Use when you need to add a new field (Text, Number, Checkbox, Date, Picklist, Lookup, etc.) to any standard or custom object without deploying metadata packages. The Tooling API provides direct field creation for rapid development and automation tasks.
Input parameters
The display label for the field shown in the Salesforce UI.
Number of decimal places for Number, Currency, or Percent fields. Must be less than precision.
Maximum character length for Text fields. Required for Text type, max 255 characters. Not applicable for LongTextArea.
If true, enforce that all values in this field are unique across all records (case-insensitive by default).
If true, this field must be populated when creating or editing records.
Total number of digits for Number, Currency, or Percent fields (including decimal places). Maximum is 18.
The type of custom field to create. Common types: Text (string up to 255 chars), LongTextArea (larger text), Number (integer or decimal), Checkbox (boolean), Date, DateTime, Picklist (single-select dropdown), MultiselectPicklist (multi-select), Lookup (relationship to another object), Email, Phone, Url, Currency, Percent.
For Picklist/MultiselectPicklist fields, if true restricts values to only those defined in the picklist (no custom values allowed).
Optional description of the field's purpose and usage.
If true, marks this field as an external ID for integration purposes (allows upsert operations and improves query performance).
For Lookup fields, the API name of the object this field references (e.g., 'Account', 'Contact', 'CustomObject__c').
Default value for the field. Format depends on field type (e.g., 'true'/'false' for Checkbox, date string for Date fields).
Number of visible lines for LongTextArea fields in the UI. Typically 3-10.
If true, checks if the field already exists before attempting creation. Prevents errors when field is already present.
The API name for the new custom field. Must end with '__c' for custom fields (e.g., 'Customer_Tier__c', 'Priority_Level__c').
The API name of the Salesforce object to add the field to (e.g., 'Account', 'Contact', 'Opportunity', or a custom object like 'Invoice__c').
List of picklist values for Picklist or MultiselectPicklist fields. Each value must have at minimum a fullName.
Optional help text shown as a tooltip when users hover over the field in the UI.
For Lookup fields, the API name for the relationship (used in queries). If not specified, Salesforce auto-generates one.
For MultiselectPicklist fields, number of visible lines to display in the UI.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_CUSTOM_OBJECTTool 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.
Input parameters
The display label for the custom object shown in the Salesforce UI (singular form).
The API name of the custom object. Must end with '__c' suffix (e.g., 'Invoice__c', 'Student__c'). This is the unique identifier for the object in Salesforce.
Configuration for the name field of the custom object. Every custom object requires a name field.
Optional description of the custom object's purpose and usage.
The plural form of the label shown in the Salesforce UI when referring to multiple records.
Defines default record-level sharing. 'ReadWrite' allows all users to read and edit, 'Read' allows read-only access, 'Private' restricts to owner only, 'ControlledByParent' inherits from parent object.
If true, enables reporting on this object. Allows users to create reports and dashboards with this object's data.
Deployment status of the custom object. 'Deployed' makes it available to all users, 'InDevelopment' restricts access to admins and developers only.
If true, enables tasks and events for this object. Allows users to track activities related to records.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_LEADCreates a new lead in Salesforce. `LastName` and `Company` are required. Org-level validation rules (e.g., email format, custom required fields) may reject requests beyond these; inspect the error response body for the failing field. The created lead `id` is returned in a response wrapper, not at the top level.
Input parameters
Lead's city.
Lead's email address.
Lead's phone number.
Lead's state/province.
Lead's job title. Maximum length is 128 characters.
Lead rating.
Lead status.
Lead's street address.
Lead's company name. Required - must be provided to create a lead.
Lead's country.
Lead's company website.
Lead's industry.
Lead's last name. Required - must be provided to create a lead.
Lead's first name.
Source of the lead.
Lead's postal/zip code.
Dictionary of custom field API names and their values. Custom field names typically end with '__c' (e.g., 'Level__c', 'Languages__c'). Use this to set any custom fields defined in your Salesforce org.
Lead's company annual revenue.
When True, allows creating duplicate leads even if Salesforce duplicate detection rules are triggered. When False (default), creation fails if duplicates are detected and returns duplicate information in the response.
Number of employees at lead's company.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_LEAD_WITH_SPECIFIED_CONTENT_TYPEDEPRECATED: Creates a new Lead in Salesforce, requiring `LastName` and `Company` unless person accounts are enabled and `Company` is null.
Input parameters
City for the address.
Email address.
Primary phone number.
State or province for the address.
Title (e.g., CFO, CEO; up to 128 characters).
Data.com contact ID (max 20 chars). Indicates Data.com import. Do not modify; for import troubleshooting.
Rating (e.g., Hot, Warm, Cold).
Current status (e.g., Open, Contacted). Defined in LeadStatus object in Salesforce setup.
Street address.
Company name (up to 255 characters). If person accounts are enabled and this is null, lead converts to a person account.
Country for the address.
ID of the owner (must be a valid 15 or 18-character Salesforce User ID starting with '005', e.g., '005XXXXXXXXXXXXXXX'). Omit or set to null to assign to the current user. The string 'me' is automatically converted to null to use the default.
Website URL.
Primary industry of the lead's company.
Last name of the lead (up to 80 characters).
Path for social network profile image URL; used with Salesforce instance URL. Empty if Social Accounts/Contacts disabled.
First name (up to 40 characters).
Indicates if the lead is in the Recycle Bin (true) or not (false). Salesforce defaults to false if this field is omitted.
Source of the lead.
Postal or ZIP code for the address.
Custom field, possibly indicates if primary contact/lead.
Custom field for Standard Industrial Classification (SIC) code.
Salutation for the lead.
Record's clean status compared with Data.com (e.g., Matched, Different, Pending).
ID of user who created this. System-generated, read-only.
Creation timestamp. System-generated, read-only.
Description (up to 32,000 characters).
True if converted to Account/Contact/Opportunity; false otherwise. Read-only; set upon conversion.
Associated data privacy record ID. Available if Data Protection/Privacy enabled.
Annual revenue of the lead’s company.
Conversion date. Read-only; set upon conversion.
Dictionary of custom field API names and their values. Custom field names typically end with '__c'.
Associated D&B Company record ID. Available if Data.com used.
Timestamp when current user last viewed. Null if only accessed (LastReferencedDate) but not viewed. Read-only.
ID of the master record if this lead was deleted due to a merge; null otherwise.
Timestamp of last modification by user or system. System-generated, read-only.
True if assigned to an owner but not yet viewed by them. Salesforce defaults to true when a lead is created or its owner changes.
Jigsaw contact ID. Read-only.
Relative URL of SObject record. Usually metadata, not set by user on creation.
Date/time of last email bounce (if bounce management active).
True if this lead is marked as a priority record.
Later of most recent event's Due Date or most recently closed task's Due Date. Read-only.
ID of user who last modified this. System-generated, read-only.
Last modification timestamp. System-generated, read-only.
SObject type (typically 'Lead'). Usually metadata, not set by user on creation.
Number of employees at the lead’s company.
ID of the Account object from conversion. Read-only.
ID of the Contact object from conversion. Read-only.
Reason for last email bounce (if bounce management active).
Timestamp when current user last accessed this or related record. Read-only.
Custom field indicating the product(s) the lead is interested in.
Custom field for information about current generators or similar equipment/services.
Custom field for the number of locations the lead's company has.
ID of the Opportunity from conversion. Read-only.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_NEW_CONTACT_WITH_JSON_HEADERDEPRECATED: 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.
Input parameters
Unique contact identifier, system-generated; omit for new contact creation.
Primary business fax. Label: Business Fax.
Read-only: Full name, a concatenation of FirstName, MiddleName, LastName, and Suffix (up to 203 characters).
Email address.
Primary business phone. Label: Business Phone.
Contact's title (e.g., CEO, Vice President).
Read-only: Data.com Company ID (max 20 chars), indicates import from Data.com. Label: Data.com Key. Do not modify.
ID of the Salesforce user owning this contact. Defaults to the logged-in user if unspecified.
Required: Contact's last name (up to 80 characters).
Custom field: Contact's level (e.g., Primary, Secondary). '__c' denotes a custom field.
Read-only: Path for social profile image URL (redirects). Empty if Social Accounts & Contacts disabled.
Parent Account ID; must exist if specified. Caution advised when changing for portal-enabled contacts.
Birthdate (YYYY-MM-DD). SOQL queries ignore year for date comparisons (e.g., `Birthdate > TODAY`).
Contact's first name (up to 40 characters).
Home phone.
Read-only: True if contact is in Recycle Bin. Label: Deleted.
Alternate address: City.
Contact's department.
Lead source for this contact (e.g., Web, Phone Inquiry).
Alternate address phone.
Alternate address: State or province.
Honorific for the contact's name (e.g., Dr., Mr., Mrs.).
Record's clean status compared to Data.com (e.g., 'Matched' may appear as 'In Sync' in UI).
Read-only: ID of user who created contact.
Read-only: Timestamp of contact creation.
Description (up to 32KB). Label: Contact Description.
Mailing address: City.
Mobile phone.
Alternate address: Street.
ID of manager contact reports to. Not for person accounts (IsPersonAccount true).
ID of associated data privacy record. Available if Data Protection & Privacy enabled.
Custom field: Languages spoken by the contact (e.g., English;Spanish). '__c' denotes a custom field.
Mailing address: State or province.
Alternate address: Country.
Assistant's name.
Source of contact information, for more granular tracking than LeadSource.
Mailing address: Street.
Alternate address: Latitude (-90 to 90, 15 decimal places). Use with OtherLongitude.
Dictionary of custom field API names and their values. Custom field names typically end with '__c'.
Assistant's phone.
True if email bounced; bounce management must be active.
Read-only: Timestamp current user last viewed contact. Null if only referenced.
Mailing address: Country.
Read-only: ID of the master record post-merge deletion; null otherwise.
Alternate address: Longitude (-180 to 180, 15 decimal places). Use with OtherLatitude.
Read-only: Timestamp of last system modification (user or automated).
Read-only: Jigsaw (Data.com) ID, links to Data.com contact data.
Mailing address: Latitude (-90 to 90, 15 decimal places). Use with MailingLongitude.
Alternate address: Postal code.
Relative URL for this SObject record, usually system-generated. Part of 'attributes' metadata.
Date and time of email bounce, if bounce management is active and an email bounced.
True if contact is a priority record.
Read-only: Most recent due date of associated event or closed task.
Read-only: Timestamp of last update from a contact update request.
Read-only: ID of user who last modified contact.
Read-only: Timestamp of last modification.
Mailing address: Longitude (-180 to 180, 15 decimal places). Use with MailingLatitude.
Salesforce SObject type, typically 'Contact'. Part of 'attributes' metadata.
Read-only: Timestamp of last contact update request (e.g., Data.com Clean).
Mailing address: Postal code.
Reason for email bounce, if bounce management is active and an email bounced.
Read-only: Timestamp current user last accessed contact, related record, or its list view.
Alternate address: Geocode accuracy. See Salesforce docs for geolocation compound fields.
Mailing address: Geocode accuracy. See Salesforce docs for geolocation compound fields.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_NOTECreates a new note attached to a Salesforce record with the specified title and content. Does not deduplicate — identical calls create duplicate notes. High-volume creation can trigger REQUEST_LIMIT_EXCEEDED; apply exponential backoff on retries.
Input parameters
Body/content of the note. Can contain detailed text information.
Title of the note (required field in Salesforce).
ID of the user who will own the note. Defaults to the current user if not specified.
ID of the record to attach the note to (required field in Salesforce). Can be any record that supports notes like Account, Contact, Lead, Opportunity, etc.
Whether the note should be private (only visible to owner and users with Modify All Data permission).
Dictionary of custom field API names and their values. Custom field names typically end with '__c' (e.g., 'Priority__c', 'Category__c'). Use this to set any custom fields defined on the Note object in your Salesforce org.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_NOTE_RECORD_WITH_CONTENT_TYPE_HEADERDEPRECATED: Creates a new Note record in Salesforce, associated with an existing Salesforce object via `ParentId`, automatically including a `Content-Type: application/json` header.
Input parameters
Unique identifier for the Note object, typically auto-generated and not provided in the request.
Content or body of the note.
Title of the note.
ID of the Salesforce User who will own the note; defaults to the API user.
ID of the parent Salesforce record (e.g., Account, Contact) to which this note is related; must reference an existing record.
Indicates if the object is in the Recycle Bin. Label is Deleted.
If true, restricts note visibility to the owner or users with "Modify All Data" permission. Label is Private.
ID of the user who created the note (system-generated, read-only on create).
Timestamp of note creation (system-generated, read-only on create).
Dictionary of custom field API names and their values. Custom field names typically end with '__c'.
Timestamp of last system change (system-generated).
API URL for the SObject. Corresponds to `attributes.url` in the JSON body (typically read-only).
ID of the user who last modified the note (system-generated).
Timestamp of last modification (system-generated).
SObject type, should be 'Note' if provided. Corresponds to `attributes.type` in the JSON body.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_OPPORTUNITYCreates a new opportunity in Salesforce with the specified information.
Input parameters
Opportunity name (required field in Salesforce).
Type of opportunity.
Estimated total sale amount.
Description of next step in sales process.
ID of the Account this opportunity is associated with. Omitting leaves the opportunity orphaned and excluded from account-based reports.
Expected close date in YYYY-MM-DD format (required field in Salesforce).
Deprecated: Salesforce Opportunity does not have a writable ContactId field. Contact-to-Opportunity associations must be managed through OpportunityContactRole. This parameter is accepted but ignored.
Current stage of the opportunity (required field in Salesforce).
Text description of the opportunity.
Source of the opportunity.
Percentage probability of closing (0-100).
Dictionary of custom field API names and their values. Custom field names typically end with '__c' (e.g., 'Custom_Field__c'). Values are subject to org-level validation rules; invalid values raise FIELD_CUSTOM_VALIDATION_EXCEPTION.
ID of the price book for this opportunity.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_OPPORTUNITY_RECORDDEPRECATED: 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.
Input parameters
System-generated unique identifier. Typically not provided during creation; providing it may be ignored or cause an error.
Descriptive name for the opportunity. Required. Limit: 120 characters.
Opportunity type (e.g., 'New Business', 'Existing Customer'). Values depend on Salesforce configuration.
Read-only. Indicates if won, lost, or open. Auto-set by Salesforce based on StageName; cannot be set on creation.
Estimated total sale amount. If products are involved, this may be auto-calculated, and direct updates might be ignored.
Fiscal period ('YYYY Q' format, e.g., '2024 1') based on CloseDate. Used if standard fiscal year settings not enabled. Often auto-derived.
ID of the User owning this opportunity. Defaults to creating user if unspecified (depending on settings). Ensure User ID is valid and active.
Read-only. Indicates if closed or open. Auto-set by Salesforce based on StageName; cannot be set on creation.
Next actionable step towards closing. Limit: 255 characters.
ID of the linked Account. Often crucial for creating a valid opportunity.
Expected close date (YYYY-MM-DD). Required.
ID of the primary Contact. Set only during creation. Use OpportunityContactRole object to modify or add other contacts later.
Indicates if the record is in the Recycle Bin. Generally used for querying, not set during creation.
If true, this opportunity is private and only visible to the owner and users with appropriate sharing access.
Read-only. Used internally by Salesforce for mobile sync updates. Not user-settable.
Current stage (e.g., 'Prospecting', 'Closed Won'). Required. May update ForecastCategoryName, IsClosed, IsWon, and Probability. Query OpportunityStage object or refer to Salesforce setup for valid names.
ID of the influencing Campaign. Ensure Campaign feature is enabled and ID is valid.
Fiscal year (e.g., 2024) of CloseDate. Often auto-derived from CloseDate based on org's fiscal year settings.
Lead or opportunity source (e.g., 'Web', 'Partner Referral'). Values depend on Salesforce configuration.
Read-only. ID of the user who created this record. Auto-set by Salesforce.
Read-only. Creation timestamp. Auto-set by Salesforce.
Detailed text description. Limit: 32,000 characters.
Likelihood (percentage, e.g., 75 for 75%) of closing. Often implied by StageName but can be overridden.
ID of the associated Price Book (Pricebook2). Generally required if adding products. Ensure products/price books are enabled and ID is valid.
Fiscal quarter (1-4) of CloseDate. Often auto-derived from CloseDate based on org's fiscal year settings.
Dictionary of custom field API names and their values. Custom field names typically end with '__c'.
Read-only. Indicates if overdue Tasks exist. API v35.0+.
Read-only. Timestamp of when current user last viewed this record. Not settable on creation.
Custom field: Associated order number.
Read-only. Last system modification timestamp. Auto-set by Salesforce.
Read-only. Calculated as Amount * Probability. Cannot be set during creation.
Read-only. Indicates if open activities (Events or Tasks) exist. API v35.0+.
Relative URL for this Opportunity record.
Forecast category (e.g., 'Pipeline', 'Best Case'). Often implied by StageName. For API v12.0+, typically set via ForecastCategoryName. Values depend on Salesforce configuration.
Read-only. Date of the most recent activity (Event or Task). Not settable on creation.
Read-only. ID of the user who last modified this record. Auto-set by Salesforce.
Read-only. Last modification timestamp. Auto-set by Salesforce.
SObject type for this record, typically 'Opportunity'.
Custom field: Associated tracking number.
Read-only. Timestamp of when current user last accessed this record or a related one. Not settable on creation.
Custom field: Identified main competitors.
Read-only. Timestamp of last StageName change. Auto-set by Salesforce.
Custom field: Information on current generators.
Name of the forecast category (e.g., 'Pipeline'). API v12.0+. Often implied by StageName but can be overridden. Typically determines ForecastCategory.
Read-only. Indicates if associated line items (products) exist. System-managed; ignored during creation.
Total quantity of items (e.g., units, licenses). Used in quantity-based forecasting.
Read-only. ID of OpportunityHistory record tracking last Amount change (API v50.0+). Not settable on creation.
Custom field: Delivery or installation status.
Read-only. ID of OpportunityHistory record tracking last CloseDate change (API v50.0+). Not settable on creation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_S_OBJECT_RECORDTool 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.
Input parameters
Dictionary of field API names and their values to set on the new record. Keys must be valid field API names for the specified object type. Required fields for the object must be included. Custom field names typically end with '__c'.
The API name of the Salesforce object type to create (e.g., 'Account', 'Contact', 'Opportunity', 'Lead', 'Case', 'Task'). This is case-sensitive and must match the exact API name in Salesforce.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_SOBJECT_TREETool 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.
Input parameters
Array of sObject record trees to create. Each record must include 'attributes' object with 'type' (matching sobject_api_name) and 'referenceId' fields, plus any standard or custom field values. Can include nested child records using relationship names (e.g., 'Contacts', 'Opportunities'). Constraints: Maximum 200 total records across all trees, maximum 5 levels deep, maximum 5 different object types.
The API name of the sObject type for root records (e.g., Account, Contact, Opportunity). All root records in the request must be of this type.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_CREATE_TASKCreates a new task in Salesforce to track activities, to-dos, and follow-ups related to contacts, leads, or other records. Ensure who_id, what_id, and owner_id reference existing records before calling; invalid IDs cause silent linkage failures or validation errors.
Input parameters
Status of the task. Must be a valid picklist value; arbitrary strings trigger validation errors.
ID of the Contact or Lead this task is associated with. Only accepts Contact IDs (prefix '003') or Lead IDs (prefix '00Q'). Do NOT use Account/Opportunity/Case IDs here; use what_id for those. Swapping who_id and what_id creates orphaned tasks that won't appear on contact/lead timelines. Accepts only a single ID; create separate task records for multiple contacts.
Subject/title of the task.
ID of the related record (Account, Opportunity, Case, etc.) this task is associated with. Accepts Account IDs (prefix '001'), Opportunity IDs (prefix '006'), Case IDs (prefix '500'), and other business object IDs.
ID of the user who owns the task. Defaults to current user if not specified.
Priority level of the task.
Detailed description or notes for the task.
Due date for the task in YYYY-MM-DD format. Do not use full datetimes or natural-language strings like 'yesterday'; only YYYY-MM-DD is accepted.
Dictionary of custom field API names and their values. Custom field names typically end with '__c' (e.g., 'Priority_Level__c': 'Critical').
Whether to set a reminder for this task.
Date and time for the reminder in ISO format (YYYY-MM-DDTHH:MM:SS). Required if is_reminder_set is true. Interpreted according to org/user timezone, not UTC.
Internal field used to communicate processing details.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_DELETE_ACCOUNTPermanently deletes an account from Salesforce. This action cannot be undone.
Input parameters
The Salesforce ID of the account to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_DELETE_A_LEAD_OBJECT_BY_ITS_IDDEPRECATED: Permanently deletes an existing Lead object from Salesforce using its unique ID.
Input parameters
The unique 15-character or 18-character ID of the Lead object to be deleted. Lead object IDs typically start with the prefix '00Q'. This is a required path parameter.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_DELETE_CAMPAIGNPermanently deletes a campaign from Salesforce. This action cannot be undone.
Input parameters
The Salesforce ID of the campaign to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_DELETE_CONTACTPermanently deletes a contact from Salesforce. This action cannot be undone. Associated records (activities, opportunities) lose the contact reference upon deletion — ensure related data is migrated or acceptable to lose before proceeding. Returns HTTP 204 with empty body on success.
Input parameters
The Salesforce ID of the contact to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_DELETE_FILETool to permanently delete a file from Salesforce. Use when you need to remove a file and its content. This operation cannot be undone.
Input parameters
The unique identifier (ID) of the file to delete in Salesforce.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_DELETE_JOB_QUERYTool 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.
Input parameters
The unique identifier of the Bulk API v2 query job to delete. Job must be in one of these states: JobComplete, Aborted, Failed, or UploadComplete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_DELETE_LEADPermanently deletes a lead from Salesforce. This action cannot be undone.
Input parameters
The Salesforce ID of the lead to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_DELETE_NOTEPermanently deletes a note from Salesforce. This action cannot be undone.
Input parameters
The Salesforce ID of the note to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_DELETE_OPPORTUNITYPermanently deletes an opportunity from Salesforce. This action cannot be undone.
Input parameters
The Salesforce ID of the opportunity to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_DELETE_SOBJECTTool 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.
Input parameters
The unique identifier of the record to delete. Must be a valid 15 or 18-character Salesforce ID format.
The API name of the Salesforce object (sObject) to delete. Examples: Account, Contact, Opportunity, CustomObject__c. Must be a valid sObject type with proper permissions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_DELETE_SOBJECT_COLLECTIONSTool to delete up to 200 records in one request with optional rollback. Use when you need to delete multiple records efficiently, reducing API calls.
Input parameters
List of record IDs to delete. Can specify up to 200 record IDs. Each ID should be a valid 15 or 18-character Salesforce ID.
Specifies whether the operation should roll back if any record fails. When true, all records must be successfully deleted or the entire operation rolls back (atomic transaction). When false (default), partial success is allowed - successfully deleted records are committed even if some deletions fail.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_EXECUTE_SOBJECT_QUICK_ACTIONTool 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.
Input parameters
Object containing field data for the record to be created. Field names and types depend on the target sObject and quick action configuration. Common fields include: Subject, Description, Status, Priority, etc.
The API name of the sObject type (e.g., 'Account', 'Contact', 'Task', 'Lead', 'Case').
The ID of the context record. For object-specific actions, this provides the parent/related record context for the action execution.
The API name of the quick action to execute (e.g., 'LogACall', 'NewTask', 'NewChildCase').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_EXECUTE_SOQL_QUERYDEPRECATED: Use SALESFORCE_RUN_SOQL_QUERY instead. Executes the provided SOQL query against Salesforce; the query must begin with 'SELECT'.
Input parameters
The SOQL (Salesforce Object Query Language) query to execute. Example: 'SELECT Id, Name, Email FROM Contact WHERE Name LIKE '%John%' LIMIT 10'. Make sure to follow SOQL syntax and escape single quotes properly. IMPORTANT - DateTime field filtering: Datetime values MUST be in ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ) and MUST NOT be enclosed in quotes. Examples: CreatedDate >= 2024-01-01T00:00:00Z, LastModifiedDate < 2024-12-31T23:59:59Z. You can also use date literals like TODAY, YESTERDAY, LAST_WEEK, THIS_MONTH, LAST_N_DAYS:30, etc. String values should be in single quotes, but datetime values should NOT be quoted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_EXECUTE_SOSL_SEARCHExecute a SOSL search to search across multiple Salesforce objects. Use when you need to search for text across multiple object types simultaneously.
Input parameters
SOSL search query string to execute. Must follow SOSL syntax with FIND clause. Special characters and spaces must be URL-encoded. Example: 'FIND {Acme} IN ALL FIELDS RETURNING Account(Name, Phone), Contact(FirstName, LastName)'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_FETCH_ACCOUNT_BY_ID_WITH_QUERYDEPRECATED: 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.
Input parameters
Unique identifier (ID) of the Salesforce Account to retrieve.
Optional comma-delimited list of Account field names to retrieve (e.g., 'Name,BillingCity,Industry'). If unspecified, null, or empty, all accessible Account fields are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_A_BATCH_OF_RECORDSTool 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).
Input parameters
Comma-separated list of qualified field names to retrieve. Format: ObjectApiName.FieldName (e.g., 'Account.Name,Account.Phone'). If the user doesn't have access to a field, an error occurs. Either fields or optionalFields must be provided.
Comma-separated list of record IDs to retrieve. All record IDs must be from supported objects. Maximum 200 records per request.
Comma-separated list of qualified optional field names. Format: ObjectApiName.FieldName (e.g., 'Account.AnnualRevenue'). If the user doesn't have access to an optional field, it's excluded from the response without error. Can be used with fields parameter. Either fields or optionalFields must be provided.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_ACCOUNTRetrieves a specific account by ID from Salesforce, returning all available fields.
Input parameters
The Salesforce ID of the account to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_ALL_CUSTOM_OBJECTSRetrieves 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.
Input parameters
Page number to retrieve (1-indexed). Defaults to 1. Must be at least 1.
Number of objects to return per page. Defaults to 50. Must be between 1 and 200 (inclusive).
If true, only returns custom objects (objects where custom=true). Defaults to false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_ALL_FIELDS_FOR_OBJECTRetrieves all fields (standard and custom) for a Salesforce object with complete metadata including field types, constraints, picklist values, and relationships.
Input parameters
API name of the Salesforce object to describe. Use standard object names (Account, Contact, Lead, Opportunity) or custom object API names ending in __c.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_ALL_NAVIGATION_ITEMSGets all navigation items (tabs) that the user has access to. Use when you need to retrieve available navigation tabs for display or navigation purposes.
Input parameters
Page offset for paginated results. Default is 0. For example, page=2 with pageSize=10 returns items starting at position 21.
Maximum number of navigation items to return per page. Default is 25.
Specifies the display size. Valid values: 'Large' (desktop, default), 'Medium' (tablet), or 'Small' (phone). Determines which navigation items are returned based on the form factor.
Comma-delimited list of TabDefinition name values to include in the response. If omitted, all navigation items for the specified form factor are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_APITool 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.
Input parameters
The Salesforce API version to query in format vXX.X (e.g., v62.0, v66.0). If not provided, uses the version from the authenticated connection.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_APPTool 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.
Input parameters
The 18-character ID of the app or the API name (developerName) of the app to retrieve.
Specifies the device form factor for which to retrieve app metadata. 'Large' for desktop/web client (default), 'Medium' for tablet client, 'Small' for phone/mobile client.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_APPSTool 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.
Input parameters
Specifies the form factor of the hardware/device the browser is running on. Determines which navigation items and metadata are returned. 'Large' for desktop/laptop, 'Medium' for tablets, 'Small' for mobile phones.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_CAMPAIGNRetrieves a specific campaign by ID from Salesforce, returning all available fields.
Input parameters
The Salesforce ID of the campaign to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_CHATTER_RESOURCESTool to access Chatter resources directory. Use when you need to discover available Chatter feeds, groups, users, email digest controls, emojis, extensions, or streams.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_CHILD_RECORDSTool 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.
Input parameters
Comma-separated list of API names of the related list's column fields to query. Supports spanning relationships in the format ObjectApiName.ChildRelationshipName.FieldApiName (e.g., Opportunity.Account.BillingAddress). If not specified, default fields are returned.
The number of list records to return per page. The default value is 5 and the value can be 1-2000.
The unique 18-character Salesforce ID of the parent record. This is the record whose child records you want to retrieve.
Token for pagination, used to navigate to a specific page of results. Obtained from the response's nextPageToken or previousPageToken fields.
Comma-separated list of additional field API names in the related list to query. These are additional fields queried for the records returned that don't create visible columns. If the field is not available to the user, no error occurs.
The API name of the child relationship (typically the plural form of the child object name). Common examples include 'Contacts', 'Opportunities', 'Cases', 'Tasks'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_COMPACT_LAYOUTSTool 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.
Input parameters
Comma-separated list of Salesforce object names to retrieve compact layouts for (e.g., 'Account', 'Account,Contact', 'Account,Contact,Lead').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_COMPOSITE_RESOURCESTool 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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_COMPOSITE_SOBJECTSRetrieves 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).
Input parameters
Array of record IDs to retrieve. Maximum 2000 IDs per request.
Array of field names to retrieve for each record. Specifies which fields to return in the response.
The sObject type name (e.g., 'Account', 'Contact', 'Lead', 'Opportunity'). This specifies which type of records to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_CONSENT_ACTIONTool to retrieve aggregated consent preferences across multiple records for a specific action. Use when you need to check if users have consented to email, tracking, fax, or other actions across Contact, Lead, User, Person Account, or Individual objects.
Input parameters
A comma-separated list of identifiers (email addresses or record IDs) for which consent data is being requested. These can be IDs of Lead, Contact, User, Person Account, or Individual records.
The consent action to check. Common values include 'email', 'track', 'fax', or 'shouldForget'. This determines what type of consent preference is being queried.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_CONTACTRetrieves a specific contact by ID from Salesforce, returning all available fields.
Input parameters
Comma-delimited string of Contact field API names to retrieve. If omitted, all fields are returned.
The Salesforce ID of the contact to retrieve. Must be a valid 18-character Salesforce ID; names or emails are not valid substitutes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_CONTACT_BY_IDRetrieves a Salesforce Contact by its unique ID; the ID must correspond to an existing Contact record in Salesforce.
Input parameters
The unique Salesforce ID of the Contact record to retrieve.
Comma-delimited string of Contact field API names to retrieve. If omitted, a default set of fields is returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_DASHBOARDGets detailed metadata for a specific dashboard including its components, layout, and filters.
Input parameters
The Salesforce ID of the dashboard to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_FILE_CONTENTReturns 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.
Input parameters
The 18-character Salesforce ID of the ContentDocument or ContentVersion file to retrieve.
Specifies a particular version of the file to retrieve. If not specified, returns the latest version.
Specifies the type of file rendition to return. Available values: THUMB120BY90, THUMB240BY180, THUMB720BY480, SVGZ, ORIGINAL_<File_Extension>.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_FILE_INFORMATIONTool 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.
Input parameters
The unique identifier for the file - 18-character Salesforce ID (ContentDocument ID or ContentVersion ID). Example: 069xx000000001AAAQ
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_FILE_SHARESReturns 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.
Input parameters
The 18-character Salesforce ID of the ContentDocument (file) for which to retrieve share information.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_GLOBAL_ACTIONSTool 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.
Input parameters
Comma-separated list of action API names to filter results (e.g., 'NewTask,NewEvent,LogACall').
Device form factor to filter actions. Valid values: 'Large' (Desktop), 'Medium' (Tablet), 'Small' (Mobile).
Comma-separated list of action types to filter (e.g., 'StandardButton,QuickAction,CustomButton,ProductivityAction').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_JOB_FAILED_RECORD_RESULTSTool 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.
Input parameters
The unique identifier of the bulk ingest job.
Pagination token from the Sforce-Locator response header of a previous request, used to retrieve the next set of results.
The maximum number of records to retrieve per page. If omitted, the API returns the maximum number of records it can send in a single page.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_JOB_SUCCESSFUL_RECORD_RESULTSTool 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.
Input parameters
The unique identifier of the bulk ingest job.
Pagination token from the Sforce-Locator response header of a previous request, used to retrieve the next set of results.
The maximum number of records to retrieve per page. If omitted, the API returns the maximum number of records it can send in a single page.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_JOB_UNPROCESSED_RECORD_RESULTSTool 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.
Input parameters
The unique identifier of the bulk ingest job.
Pagination token from the Sforce-Locator response header of a previous request, used to retrieve the next set of results.
The maximum number of records to retrieve per page. If omitted, the API returns the maximum number of records it can send in a single page.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_LAST_SELECTED_APPRetrieves 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.
Input parameters
Specifies the form factor of the hardware the browser is running on. 'Large' for desktop, 'Medium' for tablet, 'Small' for mobile. If not specified, returns metadata suitable for the current context.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_LEADRetrieves a specific lead by ID from Salesforce, returning all available fields.
Input parameters
The Salesforce ID of the lead to retrieve. Must be a Salesforce record ID (18-char format like '00QWd000005V3RmMAK'); names, emails, or external codes are not accepted — resolve to a Salesforce ID first using a search or query tool.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_LIST_VIEW_ACTIONSTool 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.
Input parameters
The 18-character ID or API name of the list view for which to retrieve header actions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_LIST_VIEW_METADATA_BATCHTool 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.
Input parameters
Comma-separated list of list view IDs to retrieve metadata for. Use the 18-character Salesforce list view IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_LIST_VIEW_METADATA_BY_NAMEReturns 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.
Input parameters
The API name of a supported Salesforce object.
The API name of the list view.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_LIST_VIEW_RECORDS_BY_IDReturns record data for a list view by its ID. Use when you need to retrieve records from a specific Salesforce list view.
Input parameters
Additional fields queried for the records returned. These fields don't create visible columns. If the field is not available to the user, an error occurs.
The API name of the field the list view is sorted by. If the name is preceded with '-', the sort order is descending.
The number of list records viewed at one time. Default value is 50. Value can be 1-2000.
A token that represents the page offset used for pagination through result sets.
The ID of the list view to retrieve records from.
Additional fields queried for the records returned. These fields don't create visible columns. If the field is not available to the user, no error occurs and the field isn't included in the records.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_LIST_VIEW_RECORDS_BY_NAMERetrieves 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.
Input parameters
Filter applied to returned records in GraphQL syntax.
Comma-separated list of additional fields to query for the records returned. If a field is not available to the user, an error occurs. Example: 'Industry,AnnualRevenue,Description'
The API name of the field to sort by. Prefix with '-' for descending order. Examples: 'Name', '-CreatedDate'
Number of list records to return per page. Default: 50. Valid range: 1-2000.
Token representing the page offset for pagination. Obtained from nextPageToken in previous responses.
A search term to filter results. Wildcards are supported.
Comma-separated list of additional fields queried for the records. If a field is not available to the user, no error occurs and the field is not included. Example: 'CustomField__c,Phone'
The API name of a supported Salesforce object (e.g., 'Account', 'Contact', 'Opportunity', 'Lead', 'Case').
The API name of a list view (e.g., 'AllAccounts', 'MyAccounts') or the 18-character list view ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_LIST_VIEW_RESULTSRetrieves the results of a list view for a specified sObject. Returns column definitions and record data with a 2,000 record limit per response.
Input parameters
The API name of the Salesforce object (e.g., 'Account', 'Contact', 'Opportunity').
The unique 18-character ID of the list view to retrieve results from.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_LOOKUP_FIELD_SUGGESTIONSTool 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.
Input parameters
Search query string used to filter and find matching records. Use for typeahead search.
Page number for pagination of results.
Number of records to return per page.
Device form factor: 'Large' for desktop, 'Medium' for tablet, 'Small' for mobile.
Type of search to perform: 'Recent' for most recently used matches, 'Search' for any match in searchable fields, 'TypeAhead' for matching names.
API name of the lookup field on the source object (e.g., 'AccountId', 'OwnerId').
API name of the object containing the lookup field (e.g., 'Opportunity', 'Account', 'Contact').
Lookup filter bindings for dependent lookups, specified as JSON string with field-value pairs for filtering.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_LOOKUP_SUGGESTIONS_CASE_CONTACTTool 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.
Input parameters
The search term being queried. Used with TypeAhead or Search to find matching records. Leave empty for Recent searches.
The page number for paginated results. Use this to navigate through multiple pages of lookup results.
Number of items to return per page. Controls the size of each page in paginated responses.
The type of search to perform. Valid values: 'Recent' (most recently used), 'TypeAhead' (matching names as user types), 'Search' (full search across searchable fields).
The source record context, including the object API name and fields. Required for dependent lookup filtering.
The API name of the lookup field (e.g., 'ContactId', 'AccountId', 'OwnerId').
The API name of the source object containing the lookup field (e.g., 'Case', 'Opportunity', 'Account').
Bindings for dependent lookup fields to apply contextual filtering based on other field values.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_MRU_LIST_VIEW_METADATATool 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.
Input parameters
The API name of the Salesforce object to retrieve MRU list view metadata for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_MRU_LIST_VIEW_RECORDSTool 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.
Input parameters
Comma-separated list of additional fields to query for returned records. An error occurs if a field is unavailable to the user.
API name of the field to sort by. Prefix with '-' for descending order (e.g., 'CreatedDate' for ascending, '-CreatedDate' for descending).
Number of list records to view at one time. Default is 50, minimum is 1, maximum is 2000.
Token representing the page offset for pagination to retrieve subsequent pages of results.
Comma-separated list of additional fields to query for returned records. No error occurs if a field is unavailable to the user.
The API name of the Salesforce object to retrieve MRU list view records for (e.g., 'Account', 'Contact', 'Opportunity').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_NOTERetrieves a specific note by ID from Salesforce, returning all available fields. Notes with IsPrivate=true require the integration user to have sufficient permissions; inaccessible private notes will not be returned.
Input parameters
The Salesforce ID of the note to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_NOTE_BY_ID_WITH_FIELDSDEPRECATED: Retrieves a Salesforce Note object by its ID, optionally specifying which fields to return; the Note ID must exist.
Input parameters
Unique identifier (ID) of the Note object to retrieve.
Comma-delimited API names of fields for the Note object (e.g., 'Title,Body'). If omitted, all accessible fields are retrieved.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_OBJECT_LIST_VIEWSReturns 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.
Input parameters
The API name of the Salesforce object to retrieve list views for (e.g., Account, Contact, Opportunity).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_OPPORTUNITYRetrieves a specific opportunity by ID from Salesforce, returning all available fields.
Input parameters
Comma-delimited string of Opportunity field API names to retrieve. If omitted, all fields are returned. Custom objects may use non-standard API names for common fields (e.g., primary contact); verify exact field API names and handle null values.
The Salesforce ID of the opportunity to retrieve. Must be a valid 15 or 18 character alphanumeric Salesforce ID (e.g., '006Wd000005FG3CIAW'). When multiple similarly named opportunities exist in search results, confirm the correct record by `Id` or other key attributes before passing the ID here.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_ORG_LIMITSTool 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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_PHOTO_ACTIONSTool 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.
Input parameters
The record ID(s) for which to retrieve photo actions. Can be a single User ID or Group ID, or comma-separated list of IDs.
Specifies the device form factor for which to return actions. Large for Desktop/laptop, Medium for Tablet, Small for Mobile phone screens. If not specified, returns actions for all form factors.
Filters the types of actions to return. Can be a single value or comma-separated list. Valid values: StandardButton, QuickAction, CustomButton, ProductivityAction.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_PICKLIST_VALUES_BY_RECORD_TYPETool 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.
Input parameters
The 18-character Record Type ID. Use '012000000000000AAA' for objects without record types (default record type).
The API name of the Salesforce object (e.g., 'Account', 'Contact', 'Opportunity', or custom object like 'Car__c').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_QUERY_JOB_INFOTool 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.
Input parameters
The unique identifier of the Bulk API v2 query job.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_QUERY_JOB_RESULTSRetrieves results for a completed Bulk API v2 query job in CSV format. Supports pagination for large datasets via maxRecords and locator parameters.
Input parameters
The unique 18-character identifier for the query job whose results you want to retrieve.
A Base64-encoded string used for pagination to retrieve the next set of records. This value is obtained from the Sforce-Locator response header of the previous request. Use this to traverse through subsequent pages of results.
Defines the number of records to be downloaded per page. If omitted, the API returns the maximum number of records it can send in a single page. Used to control page size for pagination.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_QUICK_ACTIONSTool to retrieve global and object-specific quick actions from Salesforce. Use when you need to list all available quick actions in the organization.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_RECORD_COUNTSTool to retrieve total record counts for specified Salesforce objects. Use when you need to check storage usage or understand data volume for specific sObjects.
Input parameters
Comma-separated list of Salesforce object API names to retrieve record counts for. Examples: 'Account' for a single object or 'Account,Opportunity,Contact' for multiple objects.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_RECORD_EDIT_PAGE_ACTIONSTool 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.
Input parameters
Comma-separated list of 18-character Salesforce record IDs for which to retrieve record edit actions. Multiple IDs can be provided to retrieve actions for multiple records in a single request.
The device form factor for which to retrieve actions. Valid values: 'Large' (desktop), 'Medium' (tablet), 'Small' (mobile/phone). This affects which actions are returned based on device type.
Comma-separated list of action types to filter results. Common values include: 'Standard', 'Custom', 'QuickAction', 'ProductivityAction', 'DefaultButton'.
Specifies how actions should be retrieved to control the retrieval behavior for actions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_RELATED_LIST_ACTIONSTool to get actions on related lists for record detail pages. Use when you need to retrieve metadata about all available actions (standard buttons, quick actions, custom buttons, and productivity actions) that can be performed on records within a specific related list context.
Input parameters
The 18-character Salesforce ID of the parent record for which to retrieve related list actions.
Device form factor to filter actions by device type. 'Large' for desktop, 'Medium' for tablet, 'Small' for mobile.
Comma-separated list of action types to filter results. Valid values: 'StandardButton', 'QuickAction', 'CustomButton', 'ProductivityAction'.
Controls data retrieval from cache or server. Specifies how actions should be retrieved.
The API name of the related list (e.g., 'Contacts', 'Opportunities', 'Cases'). For custom objects, use the plural form with '__r' suffix (e.g., 'Custom_Objects__r').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_RELATED_LIST_PREFERENCES_BATCHTool to get a batch of related list user preferences from Salesforce. Use when retrieving display preferences, column widths, or sort orders for multiple related lists simultaneously.
Input parameters
Comma-separated list of related list IDs. Each ID follows the format 'objectApiName.relatedListId' (e.g., 'Account.Contacts,Account.Opportunities').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_RELATED_LIST_RECORDS_CONTACTSTool 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.
Input parameters
Filter to apply to related list records, written in GraphQL syntax (e.g., '{Name: {like: "A%"}}'). Note: Semi-joins and anti-joins filters are currently not supported.
The API names of the related list's column fields to query. Supports spanning relationships using dot notation (e.g., 'Opportunity.Account.Name').
An array of field API names to sort the related list by. Important: Despite being an array, it accepts only ONE value per request.
The number of list records to return per page. Default: 50. Range: 1-1999.
Token for pagination to navigate to a specific page of results. Obtained from nextPageToken or previousPageToken in previous responses.
API names of additional fields in the related list that don't create visible columns. If a field is not available to the user, no error occurs - it's simply omitted from the response.
The API name of the related list or child relationship (e.g., 'Contacts', 'Opportunities', 'Cases'). This is typically the plural form of the object name.
The 18-character Salesforce ID of the parent record for which to retrieve related lists (e.g., Account ID, Opportunity ID).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_REPORTGets detailed metadata for a specific report including its structure, columns, filters, and groupings. Only fields included in the report layout are returned; use SALESFORCE_RUN_SOQL_QUERY when specific fields outside the report layout are required.
Input parameters
The Salesforce ID of the report to retrieve metadata for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_REPORT_INSTANCEGets the results of a report instance created by running a report. Poll `attributes.status` until it equals 'Success' before parsing results. Response data is nested under `factMap` and `reportExtendedMetadata`; an empty `factMap` or zero rows is a valid successful result, not an error.
Input parameters
The Salesforce ID of the report.
The report instance ID returned from running a report.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_SEARCH_LAYOUTRetrieves search result layout information for specified sObjects. Use when you need to understand which fields are displayed in search results for objects.
Input parameters
Comma-separated list of sObject API names for which to retrieve search layouts (e.g., 'Account,Contact'). Can include standard objects (Account, Contact, Lead, Opportunity, Case) and custom objects (CustomObject__c).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_SEARCH_SUGGESTIONSReturns 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.
Input parameters
The search query string for which to return suggested queries. This is the partial text input from the user.
The channel context for the search suggestions. Valid values: 'Pkb' (Public Knowledge Base), 'Csp' (Customer Service Portal), 'Prm' (Partner Portal), 'App' (Internal Application).
The Salesforce object type to focus the suggestions on. Limits suggestions to queries relevant to specific object types.
The language for the search suggestions. Required parameter. Use standard locale codes (e.g., 'en_US', 'fr_FR').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_SOBJECT_BY_EXTERNAL_IDTool 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.
Input parameters
Comma-separated list of field names to return. If not specified, returns all fields.
The API name of the Salesforce object (e.g., Account, Contact, Custom__c).
The API name of the external ID field. Must be marked as an External ID field in the object's field definition.
The value of the external ID field to match. Will be URL-encoded automatically.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_SOBJECT_COLLECTIONSTool 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.
Input parameters
Comma-separated list of record IDs to retrieve. Maximum 200 IDs for GET requests. Example: '001xx000003DGb2AAG,001xx000003DGb3AAG'.
Comma-separated list of field names to retrieve for each record. Specifies which fields to return in the response. Example: 'Name,BillingCity,Email'.
If true, the entire operation rolls back if any record fails. If false (default), partial success is allowed and errors are returned for individual failed records.
The sObject type name to retrieve records from (e.g., 'Account', 'Contact', 'Lead', 'Opportunity').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_SOBJECT_LIST_VIEWTool 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.
Input parameters
The unique identifier (18-character ID) of the specific list view to retrieve.
The type of sObject to which the list view applies (e.g., Account, Contact, Opportunity).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_SOBJECT_LIST_VIEWSTool 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.
Input parameters
The API name of the sObject type (e.g., Account, Contact, Lead, Opportunity, Case). Required to specify which object type's list views to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_SOBJECT_PLATFORMACTIONRetrieves metadata description of PlatformAction SObject. Use when you need to understand the structure and fields of PlatformAction for querying UI actions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_S_OBJECT_QUICK_ACTION_DEFAULT_VALUESRetrieves 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.
Input parameters
The API name of the sObject type (e.g., Account, Contact, Case, Opportunity).
The ID of the parent/context record that the action is related to. Used to calculate context-specific default values based on the parent record.
The API name of the quick action (e.g., LogACall, NewContact, _LightningRelatedContact).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_SOBJECT_QUICK_ACTION_DEFAULT_VALUESRetrieves 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.
Input parameters
The API name of the sObject type (e.g., 'Account', 'Contact', 'Task').
The API name of the quick action (e.g., '_LightningRelatedContact', 'LogACall', 'NewTask').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_S_OBJECT_RECORDTool to retrieve a single Salesforce record by ID from any sObject type. Use when you need to get detailed information about a specific record.
Input parameters
Comma-separated list of field names to retrieve from the record. If omitted, all fields are returned. Example: Name,Id,CreatedDate,Industry
The unique Salesforce record ID (15 or 18 characters). The 3-character prefix indicates the object type (e.g., '001' for Account, '003' for Contact, '00Q' for Lead). Ensure the sobject_api_name matches the record ID prefix.
The API name of the Salesforce sObject type (e.g., Account, Contact, Opportunity, Custom__c). Object names are not case-sensitive. Ensure the sObject type matches the record ID prefix (e.g., Account IDs start with '001', Contact with '003', Lead with '00Q').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_SOBJECT_RELATIONSHIPRetrieves 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).
Input parameters
The 15 or 18-character Salesforce ID of the parent record.
Comma-separated list of fields to retrieve from the related records. If not specified, returns default fields.
The parent sObject type (e.g., 'Account', 'Contact', 'Opportunity'). Must be a valid Salesforce object type.
The name of the relationship field to traverse (e.g., 'Contacts' for Account.Contacts, 'Opportunities' for Account.Opportunities).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_S_OBJECTS_DESCRIBE_LAYOUTS_RECORD_TYPE_IDTool 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.
Input parameters
The API name of the Salesforce object to retrieve layout information for.
The 18-character ID of the record type for which to retrieve layout information.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_SOBJECTS_SOBJECT_DESCRIBE_APPROVALLAYOUTSRetrieves 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.
Input parameters
The API name of the Salesforce object to retrieve approval layouts for. Use standard object names (Account, Contact, Opportunity, Case) or custom object API names ending in __c.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_S_OBJECTS_UPDATEDTool 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.
Input parameters
End of the timeframe for which to retrieve updated records. Must be in ISO 8601 format (e.g., 2025-12-23T23:59:59Z). The date range between start and end cannot exceed 30 days.
Start of the timeframe for which to retrieve updated records. Must be in ISO 8601 format (e.g., 2025-12-23T10:22:26Z). Cannot be more than 30 days ago from the current date.
The API name of the sObject type to query for updated records (e.g., Account, Contact, CustomObject__c).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_SUPPORTRetrieves the root of the Support Knowledge REST API. Use when you need to access knowledge articles and data category information.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_SUPPORTED_OBJECTS_DIRECTORYTool 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.
Input parameters
Comma-separated list of object API names to filter the response. When provided, only returns metadata for the specified objects. If omitted, returns all available objects.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_SUPPORT_KNOWLEDGE_ARTICLESRetrieves 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.
Input parameters
Sort order for results (e.g., 'mostViewed').
Filter articles by topics.
Specifies the visibility channel through which articles are accessed. Valid values: 'App' (internal app), 'Pkb' (public knowledge base), 'Csp' (customer portal), 'Prm' (partner portal).
Number of articles to return per page for pagination.
Filters articles by data category groups and categories. Format varies based on category structure.
Page number for paginated results.
Filter by publication status. Values: 'Draft', 'Online' (published), 'Archived'. Note: Requires 'Manage Articles' permission for 'Online' status. In API version 47.0+ with Lightning Knowledge, all statuses are returned by default.
Language for the knowledge articles. Must be specified in HTTP header format (e.g., 'en-US', 'en-US,en;q=0.9'). This field is required by the Salesforce API.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_THEMETool to get icons and colors for Salesforce UI themes. Use when you need to retrieve theme information for objects in the organization.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_UI_API_ACTIONS_LOOKUP_ACCOUNTTool 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).
Input parameters
Comma-separated list of action sections to include in the response.
The device form factor for which to retrieve actions. Valid values: 'Large' (desktop), 'Medium' (tablet), 'Small' (mobile).
Comma-separated list of action types to filter (e.g., 'standard,custom').
The API name of the object for which to retrieve lookup field actions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_UIAPI_ACTIONS_MRU_LIST_ACCOUNTTool 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.
Input parameters
Specifies the device form factor for which to return actions (e.g., 'Large' for desktop, 'Small' for mobile).
Filters the types of actions to return. Can be used to limit the response to specific action categories.
The API name of the Salesforce object for which to retrieve MRU list view actions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_UI_API_ACTIONS_RECORD_RELATED_LISTTool to get available actions on related lists for a record detail page. Use when you need to retrieve metadata about actions (standard actions, custom actions, quick actions, productivity actions) displayed on related lists for a specific parent record.
Input parameters
The 18-character ID of the parent record for which to retrieve related list actions.
The form factor of the device running the browser. Valid values: 'Large' (desktop), 'Medium' (tablet), 'Small' (phone). This affects which actions are returned based on device type.
Comma-separated list of action types to filter results. Common values include: 'Standard', 'Custom', 'QuickAction', 'ProductivityAction', 'DefaultButton'.
Specifies how actions should be retrieved to control the retrieval behavior for actions.
Comma-separated list of related list API names to filter the actions. For custom objects, use the plural form with '__r' suffix (e.g., 'Custom_Objects__r').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_UI_API_APPS_USER_NAV_ITEMSTool 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.
Input parameters
Page offset starting position (default: 0). Example: page=2 with pageSize=10 returns items 21-30.
The ID of the Salesforce application for which to retrieve navigation items.
Maximum number of navigation items per page (default: 25).
Specifies the device form factor for which to retrieve navigation items. Valid values: 'Large' (desktop, default), 'Medium' (tablet), or 'Small' (phone).
List of TabDefinition name values to include. If omitted, returns all navigation items for the specified form factor.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_UIAPI_LIST_INFO_ACCOUNT_ALL_ACCOUNTSRetrieves 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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_UIAPI_LIST_INFO_ACCOUNT_RECENTTool 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.
Input parameters
The API name of the Salesforce object. Examples: Account, Contact, Lead, Opportunity, CustomObject__c.
The API name of the list view. Examples: AllAccounts, MyAccounts, __Recent. Special values like __Recent represent system-defined list views.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_UIAPI_LIST_INFO_ACCOUNT_SEARCH_RESULTRetrieves 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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_UI_API_LIST_INFO_RECENTTool 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.
Input parameters
Search term to filter list view results. Supports wildcards.
Number of list view records to return per page. Valid range: 1-2000. Default: 20.
Page offset for pagination. Maximum offset: 2000. Default: 0.
The API name of the Salesforce object to retrieve list views for. Examples: Account, Contact, Lead, Opportunity, CustomObject__c.
When true, returns only recently used list views. When false, returns all list views for the object.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_UIAPIMRU_LIST_INFO_ACCOUNTTool 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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_UI_API_MRU_LIST_RECORDS_ACCOUNTTool 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.
Input parameters
Additional fields queried for the records returned that don't create visible columns. If the field is not available to the user, an error occurs.
The API name of the field the list view is sorted by. If the name is preceded with '-', the sort order is descending. Example: 'CreatedDate' (ascending) or '-CreatedDate' (descending).
The number of list records viewed at one time. Default value is 50. Value can be 1-2000.
Token representing the page offset for pagination. Used to retrieve subsequent pages of results.
Additional fields queried for the records returned that don't create visible columns. If the field is not available to the user, no error occurs and the field isn't included in the records.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_UI_API_RECORD_UITool 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.
Input parameters
Comma-separated access modes for the record. Valid values: 'Create' (for creating records), 'Edit' (for editing records), 'View' (for displaying records). Determines which fields to get from layout.
Number of child relationship records per page. Default: 5.
Comma-separated list of up to 200 record IDs. All IDs must be from supported objects.
Specifies device form factor. Valid values: 'Large' (desktop), 'Medium' (tablet), 'Small' (mobile phone).
Comma-separated layout types to return. Valid values: 'Compact' (key fields layout), 'Full' (full layout).
Comma-separated list of additional field names to include in format ObjectApiName.FieldApiName. If field is accessible to user, it's included in response; otherwise silently omitted without error.
Comma-separated list of child relationships to include in format ObjectApiName.ChildRelationshipName (e.g., 'Account.Contacts,Account.Opportunities'). Child records are paginated with default pageSize of 5.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_UIAPI_RELATED_LIST_PREFERENCESTool to retrieve user preferences for a specific related list on an object. Use when you need to get display settings, column widths, or sort preferences for related lists in Salesforce UI.
Input parameters
The API name of the parent object whose related list preferences you want to retrieve.
The API name of the related list for which you want to retrieve user preferences.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_GET_USER_INFORetrieves information about the current user or a specific user in Salesforce.
Input parameters
The Salesforce User ID to retrieve information for. If not provided, returns current user info.
Whether to include user permissions in the response (requires additional API call). Requires elevated access; permission data is returned inside salesforce_user_details and may be partially masked based on the user's profile.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_HEAD_ACTIONS_CUSTOMTool 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.
Input parameters
Conditional header that returns data only if the resource hasn't been modified since the specified date. Uses HTTP date format (RFC 7231). Example: 'Wed, 21 Oct 2015 07:28:00 GMT'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_HEAD_ACTIONS_STANDARDTool 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.
Input parameters
Conditional header that returns data only if the resource has been modified since the specified date. Uses HTTP date format (RFC 2822/7232). Example: 'Thu, 05 Jul 2012 15:31:30 GMT'. If not modified, returns 304 status code.
Conditional header that returns data only if the resource hasn't been modified since the specified date. Uses HTTP date format (RFC 2822/7232). Example: 'Tue, 10 Aug 2015 00:00:00 GMT'. If modified, returns 412 status code.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_HEAD_APPMENU_SALESFORCE1Tool 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.
Input parameters
Entity tag (ETag) for conditional request. If the resource matches this ETag, returns 304 Not Modified.
Timestamp for conditional request. Request succeeds only if data changed since specified date/time, otherwise returns 304 Not Modified. Format: RFC 2822 date-time (e.g., 'Mon, 15 Jan 2024 12:00:00 GMT').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_HEAD_PROCESS_RULES_S_OBJECTTool 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.
Input parameters
The Salesforce object name (sObject) to retrieve process rules headers for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_HEAD_QUICK_ACTIONSTool 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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_HEAD_SOBJECT_QUICK_ACTION_DEFAULT_VALUESTool 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.
Input parameters
The record ID that provides context for retrieving the default values. This is typically the ID of an existing record (Account, Contact, Lead, Opportunity, etc.) that the quick action is being invoked from.
The API name of the quick action (e.g., 'LogACall', 'NewTask', 'NewContact', 'SendEmail'). This is the specific action you want to get headers for.
The sObject type (e.g., 'Account', 'Contact', 'Lead', 'Opportunity'). This specifies which sObject the quick action belongs to.
ETag value for conditional requests. Returns 304 Not Modified if content hasn't changed since the specified ETag.
Date format: EEE, dd MMM yyyy HH:mm:ss z. Returns 304 Not Modified if the action metadata has not changed since the specified date.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_HEAD_SOBJECTS_GLOBAL_DESCRIBE_LAYOUTSTool 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.
Input parameters
ETag value for strong validation. Request succeeds only if the resource's ETag doesn't match the provided value(s). Multiple ETags can be specified as comma-separated values.
Timestamp for weak validation. Request succeeds only if the resource has been modified since the specified date and time. Format: HTTP date (RFC 7231).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_HEAD_SOBJECTS_QUICK_ACTIONTool 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.
Input parameters
The specific quick action name for which to retrieve headers (e.g., NewCase, LogACall, SendEmail).
The sObject type for which to retrieve quick action headers (e.g., Account, Contact, Case, Lead).
ETag value for conditional requests. Returns 304 Not Modified if content hasn't changed since the specified ETag.
Time-based conditional header that returns data only if the resource has been modified since the specified date. Uses HTTP date format (RFC 7231). Example: 'Wed, 21 Oct 2015 07:28:00 GMT'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_HEAD_SOBJECTS_USER_PASSWORDTool 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.
Input parameters
The Salesforce User record identifier (18-character User ID).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_LIST_ACCOUNTSLists accounts from Salesforce using SOQL query, allowing flexible filtering, sorting, and field selection. Results paginate via nextRecordsUrl with up to ~2000 rows per page. REQUEST_LIMIT_EXCEEDED requires exponential backoff; INVALID_FIELD or INSUFFICIENT_ACCESS_OR_READONLY errors indicate profile or field-level restrictions — simplify SELECT/WHERE clauses.
Input parameters
SOQL query to fetch accounts. Use standard SOQL syntax to filter, sort, and limit results. Always include WHERE and LIMIT clauses to avoid oversized responses. Avoid FIELDS(ALL) without LIMIT. Website and Phone are frequently null; avoid filtering on them without tolerating null values. To include parent-child relationships, explicitly add ParentId or Parent.Name to the SELECT clause.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_LIST_ANALYTICS_TEMPLATESTool to list CRM Analytics templates available in the org. Use when you need to discover available templates for creating Analytics apps.
Input parameters
Page number for pagination (1-based indexing). Specifies which page of results to retrieve.
Filter templates by type. App returns app templates, Dashboard returns dashboard templates, Data returns data templates, Embedded returns embedded templates, Lens returns lens templates.
Filter templates by visibility. CreateApp returns templates that can be used to create apps, ManageableOnly returns templates the user can manage, ViewOnly returns templates the user can only view.
Number of results per page. Controls how many template records are returned in a single response.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_LIST_CAMPAIGNSLists campaigns from Salesforce using SOQL query, allowing flexible filtering, sorting, and field selection. Results returned under `response_data.records`; use `Id` (not `Name`) to identify campaigns in downstream operations.
Input parameters
SOQL query to fetch campaigns. Use standard SOQL syntax to filter, sort, and limit results. To disambiguate similarly named campaigns, filter on `Type`, `Status`, `StartDate`, or `EndDate`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_LIST_CONTACTSLists contacts from Salesforce using SOQL query, allowing flexible filtering, sorting, and field selection. Results are returned under `response_data.records`; check `response_data.done` and `response_data.totalSize` for pagination — use OFFSET or `nextRecordsUrl` until `done=true` to retrieve all records.
Input parameters
SOQL query to fetch contacts. Use standard SOQL syntax to filter, sort, and limit results. String literals must be single-quoted. Use correct field API names and relationship traversal (e.g., `Account.Industry`). To filter unassociated contacts use `AccountId = NULL`. Omitting an `AccountId` or `Account.Name` filter returns contacts across all accounts. Nullable fields like `LastActivityDate` require explicit null checks; use `ORDER BY ... NULLS FIRST` for null-safe sorting.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_LIST_CUSTOM_INVOCABLE_ACTIONSRetrieves 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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_LIST_DASHBOARDSLists all dashboards available in Salesforce with basic metadata including name, ID, and URLs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_LIST_EMAIL_TEMPLATESLists available email templates in Salesforce with filtering and search capabilities.
Input parameters
Maximum number of templates to return.
Field to sort results by.
Filter by folder name to get templates from a specific folder.
Search term to filter templates by name. Uses LIKE operator for partial matches.
Whether to include the template body content in results. Note: This may increase response size significantly.
Filter by template type. Common values: text, custom, html, visualforce.
Whether to return only active templates. Set to false to include inactive templates.
Sort direction: ASC for ascending, DESC for descending.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_LIST_LEADSLists leads from Salesforce using SOQL query, allowing flexible filtering, sorting, and field selection. Results are paginated; follow nextRecordsUrl in the response to retrieve subsequent pages — the first page may silently omit matching records beyond the page limit.
Input parameters
SOQL query to fetch leads. Use standard SOQL syntax to filter, sort, and limit results. Field API names must be exact (e.g., LeadSource, LastModifiedDate) — invalid names cause MALFORMED_QUERY errors. Date literals like TODAY use the org timezone; use explicit ranges (e.g., LastModifiedDate >= TODAY AND LastModifiedDate < TOMORROW) to avoid boundary misses. Filter null Email with WHERE Email != null when downstream steps require it. Narrow LastModifiedDate ranges to avoid row-limit truncation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_LIST_NOTESLists notes from Salesforce using SOQL query, allowing flexible filtering, sorting, and field selection. Designed specifically for Note and ContentNote objects.
Input parameters
SOQL query to fetch notes. Use standard SOQL syntax to filter, sort, and limit results. This action is specifically designed for Note and ContentNote objects. For other objects like EmailMessage (which uses 'Subject' instead of 'Title'), use the general SOQL query action instead. Always include a LIMIT clause to avoid over-fetching; the default query has no LIMIT and may return very large payloads. Omit Body or use TextPreview (ContentNote only) when full note content is not needed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_LIST_OPPORTUNITIESLists opportunities from Salesforce using SOQL query, allowing flexible filtering, sorting, and field selection. Results are paginated up to ~2000 rows per batch; check `done`, `totalSize`, and `nextRecordsUrl` fields to detect and retrieve additional pages, or use a SOQL `LIMIT` clause to cap results. For complex queries rejected by this tool, use `SALESFORCE_RUN_SOQL_QUERY` instead.
Input parameters
SOQL query to fetch opportunities. Use standard SOQL syntax to filter, sort, and limit results. Omitting a `WHERE` clause returns all opportunities including historical ones. Results have no default sort order; include `ORDER BY CloseDate DESC` to retrieve recent opportunities first.IMPORTANT: Only use standard Salesforce fields unless you have confirmed that custom fields exist in the target org. Custom fields (ending with '__c') are org-specific and may not exist in all Salesforce instances. For relationship queries (e.g., Owner.Name), only use standard fields on the related object. To discover available fields, use the SALESFORCE_GET_ALL_FIELDS_FOR_OBJECT action first.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_LIST_PRICEBOOK_ENTRIESLists 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. When using returned IDs with SALESFORCE_ADD_OPPORTUNITY_LINE_ITEM, always filter with WHERE IsActive = true — inactive entries cause REQUIRED_FIELD_MISSING or INVALID_CROSS_REFERENCE_KEY errors.
Input parameters
SOQL query to fetch pricebook entries. Use standard SOQL syntax to filter, sort, and limit results.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_LIST_PRICEBOOKSLists pricebooks from Salesforce using SOQL query, allowing flexible filtering, sorting, and field selection. Use this to map pricebook names to IDs.
Input parameters
SOQL query to fetch pricebooks. Use standard SOQL syntax to filter, sort, and limit results.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_LIST_REPORTSLists all reports available in Salesforce with basic metadata including name, ID, and URLs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_LIST_STANDARD_INVOCABLE_ACTIONSRetrieves 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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_LOG_CALLLogs a completed phone call as a task in Salesforce with call-specific details like duration, type, and disposition.
Input parameters
ID of the Contact or Lead associated with the call. Invalid or non-existent IDs create orphaned or mislinked activity records.
Subject line for the call log. Defaults to 'Call'.
ID of the related record (Account, Opportunity, Case, etc.) associated with the call.
Detailed notes or description of what was discussed during the call.
Date of the call in YYYY-MM-DD format. Defaults to today if not specified.
Standard Salesforce Task CallType values. This is a restricted picklist.
Dictionary of custom field API names and their values. Custom field names typically end with '__c' (e.g., 'Call_Outcome__c').
Outcome or result of the call. Restricted picklist — only org-configured values are accepted; unlisted values cause validation errors.
Duration of the call in seconds.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_LOG_EMAIL_ACTIVITYCreates an EmailMessage record to log email activity in Salesforce, associating it with related records. Requires EmailMessage insert permissions enabled at the org level; some orgs block this entirely.
Input parameters
Status of the email. 0=New, 1=Read, 2=Replied, 3=Sent, 4=Forwarded, 5=Draft
Subject line of the email.
HTML body of the email. If provided, takes precedence over text_body for display.
ID of the parent record, typically a Case for case-related emails.
Plain text body of the email.
CC email addresses (comma-separated if multiple).
Email addresses of the recipients (comma-separated if multiple).
BCC email addresses (comma-separated if multiple).
Whether this is an incoming email (true) or outgoing email (false).
Email address of the sender.
Date/time the email was sent in ISO format. Defaults to current time if not provided. Must be an explicit ISO datetime string; relative expressions like 'yesterday' cause validation errors.
Dictionary of custom field API names and their values. Custom field names typically end with '__c' (e.g., 'Email_Category__c').
ID of the record to associate this email with (Account, Opportunity, Case, etc.). Must reference a supported object type (Account, Opportunity, Case, Contact, Lead, etc.); unsupported object types cause validation errors or create standalone records invisible on timelines.
Whether the email is client-managed (not sent through Salesforce).
Whether the email is visible in customer portals/communities.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_MASS_TRANSFER_OWNERSHIPTransfers ownership of multiple records to a new owner in a single operation using Salesforce's composite API for better performance. Operation has no rollback; all provided records are reassigned immediately.
Input parameters
List of record IDs to transfer ownership.
The Salesforce object type for the records to transfer (e.g., Account, Contact, Lead, Opportunity).
The user ID of the new owner to transfer records to.
Whether to trigger Salesforce assignment rules when transferring records. Applies mainly to Leads and Cases where assignment rules may reassign the record or send notifications.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_PARAMETERIZED_SEARCHTool to execute RESTful search using parameters instead of SOSL clause. Use when you need to search across Salesforce objects with simple GET requests (URL parameters) or complex POST requests (JSON body with advanced filtering). POST method supports DataCategories, networks, orderBy constraints, and per-object filtering.
Input parameters
The search string to search for across Salesforce objects. This is the primary search term.
Search scope specifying which fields to search. Valid values: ALL, NAME, EMAIL, PHONE, SIDEBAR. Defaults to ALL.
Global filter conditions for the search results. Use standard SOQL WHERE clause syntax (without the 'WHERE' keyword).
For GET: comma-separated string of fields in format 'Object.field1,Object.field2'. For POST: array of field names to return globally across all objects.
HTTP method to use. Use GET for simple searches with URL parameters, or POST for complex searches with JSON body including advanced filtering.
For GET: comma-separated string of object names (e.g., 'Account,Contact'). For POST: array of SObjectFilter objects with name, fields, and where clauses.
Maximum number of results to return across all objects. Helps control result set size.
Enable spell correction for search terms to find results even with misspelled queries.
Default search scope for the query when not explicitly specified.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_PATCH_COMPOSITE_SOBJECTSTool 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.
Input parameters
Array of record objects to upsert. Maximum 200 records. Each record must include the 'attributes' object with the 'type' field, and the external ID field value for matching.
Controls transaction behavior. If true, rolls back all changes if any record fails. If false (default), commits successful records even if others fail.
The API name of the Salesforce object (e.g., 'Account', 'Contact', 'CustomObject__c').
The API name of the external ID field to use for matching records (e.g., 'External_Account_ID__c', 'Id'). This field must be defined as an external ID field in Salesforce.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_POST_COMPOSITE_GRAPHTool 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.
Input parameters
Array of graph objects. Each graph can contain up to 500 subrequests and reach up to 15 levels of depth. All operations within a graph succeed or fail together. Subrequests in one graph cannot reference subrequests from another graph.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_POST_COMPOSITE_SOBJECTSTool 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.
Input parameters
Array of sObject records to create. Minimum 1 record, maximum 200 records per request. Each record must include an 'attributes' object with the 'type' field specifying the sObject API name (e.g., Account, Contact), followed by field name-value pairs. Records are created in the order listed.
Determines whether the request should be processed atomically. When true, all records must succeed or the entire request is rolled back. When false (default), partial success is allowed and each record is processed independently.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_POST_PARAMETERIZED_SEARCHTool 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.
Input parameters
The search string to search for across Salesforce objects. This is the primary search term used in the SOSL FIND clause.
Search scope specifying which fields to search. Valid values: 'ALL' (ALL FIELDS), 'NAME' (NAME FIELDS), 'EMAIL' (EMAIL FIELDS), 'PHONE' (PHONE FIELDS), 'SIDEBAR' (SIDEBAR FIELDS). Defaults to 'ALL'.
Global WHERE clause applied to all sObjects (without the WHERE keyword). Uses standard SOQL WHERE clause syntax.
Default fields to return for all sObjects if not specified per object. Field API names like \['Id', 'Name', 'Email'\].
Array of sObject specifications to limit search scope. Each object specifies which Salesforce object type to search and optional filters.
Default limit per sObject when not specified in the sobjects array. Default is 25.
Maximum total number of records to return across all sObjects. Default is 2000, maximum is 2000.
Enable spell correction for search terms. Default is true.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_QUERYDEPRECATED: Use SALESFORCE_RUN_SOQL_QUERY instead. 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.
Input parameters
The SOQL query string to execute. Must be a valid SOQL statement (e.g., 'SELECT Name FROM Account'). The query will be automatically URL-encoded.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_QUERY_ALLTool 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.
Input parameters
The SOQL query to execute. Unlike standard queries, QueryAll includes soft-deleted records (from merge or delete operations) and archived Task/Event records. Example: 'SELECT Id, Name FROM Account WHERE IsDeleted = true'. Use standard SOQL syntax.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_QUERY_CONTACTS_BY_NAMEDEPRECATED: Finds Salesforce Contact records by name using a case-insensitive search.
Input parameters
Maximum number of contact records to return.
Comma-separated list of Salesforce Contact object field API names to retrieve. Common field API names include: Id, Name, FirstName, LastName, Email, Phone, MobilePhone, Title, AccountId.
The name or partial name to search for within the 'Name' field of Salesforce Contact records. Supports partial matches (e.g., 'John' will find 'John Smith', 'John Doe', etc.).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_QUERY_REPORTDEPRECATED: 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.
Input parameters
The unique identifier (ID) of the report to query.
The display name of the report. This is typically used for display purposes and may not be unique.
Configuration for the chart to be displayed with the report, if any.
Defines the scope of the data on which you run the report. For example, you can run the report against all opportunities, opportunities you own, or opportunities your team owns. Valid values depend on the report type.
A list of dictionaries specifying the columns and direction for sorting the report data. Each dictionary should define 'column' (API name) and 'sortOrder' ('asc' or 'desc').
A list of bucket field definitions to apply to the report.
Limits report output to a specified number of top or bottom rows.
Supported currency codes for reports.
Determines the division of records to include in the report (e.g., West Coast, East Coast). Available only if your organization uses divisions to segment data and you have the 'Affected by Divisions' permission. If you do not have this permission, reports include records in all divisions.
The ID of the folder where the report is stored. Necessary if identifying the report by `developerName` within a specific folder.
List of aggregate field identifiers to include in the report (e.g., sum of Amount as 's!Amount', average of Amount as 'a!Amount').
Specifies the type of the report, including its unique API name (`type`) and display name (`label`). This defines the objects and fields available for reporting.
A list of cross-object filters to apply to the report.
The desired format for the report output. Determines the structure of the data returned.
A list of API names of the columns to include in the detail section of the report.
The unique API developer name of the report being queried. This is often used to identify a saved report definition.
A list of field groupings to be applied down rows (for summary or matrix reports).
If true, the report output will include individual record rows (detail rows). If false, only summary data is returned.
A list of filter conditions to apply to the report data. Each filter specifies a column, operator, and value.
If true, the report output will include subtotals for groupings.
If true, the report will display the total number of records.
If true, the report output will include a grand total summary.
A list of field groupings to be applied across columns (for matrix reports).
A list of standard filters to apply, typically specific to the `reportType`. Each filter is a dictionary with 'name' and 'value' string pairs.
A filter based on a standard or custom date range for a specific date field.
A list of row-level (custom detail) formula definitions for the report.
Presentation settings for the report.
A string defining the logical relationship between multiple `reportFilters`. Uses 1-based indexing for filters (e.g., '(1 AND 2) OR 3').
A list of custom summary formula definitions for the report.
A list of dates for which historical trending data should be retrieved. Dates should be in YYYY-MM-DD format.
The ID of a user or role used to filter the report based on role hierarchy (e.g., 'My Team's Opportunities').
Indicates if fields used in the report are allowed in custom detail formulas.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_REMOVE_ACCOUNT_BY_UNIQUE_IDENTIFIERDEPRECATED: Deletes an existing Salesforce Account using its unique ID, returning an empty response on success (HTTP 204).
Input parameters
Unique Salesforce Account ID (typically 15 or 18 characters).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_REMOVE_A_SPECIFIC_CONTACT_BY_IDDEPRECATED: Permanently deletes a specific Contact from Salesforce using its unique ID, which must correspond to an existing record.
Input parameters
The unique identifier (ID) of the Contact object to be deleted. This is a required path parameter. Salesforce IDs are typically 15-character case-sensitive or 18-character case-insensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_REMOVE_CAMPAIGN_OBJECT_BY_IDDEPRECATED: Permanently deletes a specific Campaign SObject in Salesforce using its unique ID.
Input parameters
The unique Salesforce identifier (typically 18-character) of the Campaign SObject to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_REMOVE_FROM_CAMPAIGNRemoves 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.
Input parameters
The Salesforce ID of the lead or contact to remove from the campaign. Either member_id or campaign_member_id must be provided.
The Salesforce ID of the campaign to remove the member from.
The specific CampaignMember record ID to delete. Either member_id or campaign_member_id must be provided.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_REMOVE_NOTE_OBJECT_BY_IDDEPRECATED: Permanently deletes an existing Salesforce Note object identified by its unique ID.
Input parameters
The unique 15-character or 18-character Salesforce ID of the Note object to be deleted.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_REMOVE_OPPORTUNITY_BY_IDDEPRECATED: Permanently deletes an existing Salesforce Opportunity by its ID; if the Opportunity does not exist, a 'not found' (404) error occurs.
Input parameters
Unique identifier of the Salesforce Opportunity to be deleted, e.g., '001R0000005hDFYIA2'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_RETRIEVE_ACCOUNT_DATA_AND_ERROR_RESPONSESDEPRECATED: Retrieves comprehensive metadata for the Salesforce Account sObject, detailing its properties, recent records, and related resource URLs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_RETRIEVE_CAMPAIGN_DATA_WITH_ERROR_HANDLINGDEPRECATED: Retrieves comprehensive information and metadata for the Salesforce Campaign sObject, provided it is enabled and accessible in the organization, and features robust error handling.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_RETRIEVE_CONTACT_INFO_WITH_STANDARD_RESPONSESDEPRECATED: Retrieves comprehensive metadata (e.g., fields, data types, picklist values) for the Salesforce Contact SObject; this action does not retrieve individual contact records.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_RETRIEVE_LEAD_BY_IDRetrieves details for a Salesforce Lead by its ID; the specified Lead ID must exist in Salesforce.
Input parameters
Unique identifier (ID) of the Salesforce Lead to retrieve.
Comma-delimited list of Salesforce Lead field API names to return (e.g., Name,Email,Company). Field names must be exact API names (alphanumeric with underscores, no spaces). Custom fields typically end with '__c'. If omitted, all accessible fields are returned.
Internal field to store message about filtered fields.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_RETRIEVE_LEAD_DATA_WITH_VARIOUS_RESPONSESDEPRECATED: Retrieves Lead sObject data from Salesforce, such as recently viewed leads or general Lead object information.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_RETRIEVE_NOTE_OBJECT_INFORMATIONDEPRECATED: Retrieves comprehensive metadata for the Salesforce 'Note' SObject, if it is enabled and accessible, to understand its structure and capabilities.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_RETRIEVE_OPPORTUNITIES_DATARetrieves all available Opportunity records, representing potential revenue-generating deals, from Salesforce.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_RETRIEVE_OPPORTUNITY_BY_ID_WITH_OPTIONAL_FIELDSDEPRECATED: Retrieves a Salesforce Opportunity by its ID; the Opportunity ID must exist.
Input parameters
The unique Salesforce ID of the Opportunity record to retrieve. This is a required path parameter.
An optional, comma-delimited list of API names of the Opportunity fields to retrieve. If not specified, all accessible fields for the Opportunity object will be returned. This parameter is used as a query parameter in the GET request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_RETRIEVE_SPECIFIC_CAMPAIGN_OBJECT_DETAILSDEPRECATED: Retrieves details for a specific Salesforce Campaign object by its ID, optionally limiting to specified fields; the Campaign object must exist.
Input parameters
The unique identifier (ID) of the Salesforce Campaign object to retrieve. Example: '001R0000005hDFYIA2'.
Optional comma-delimited list of field API names for the Campaign object whose values you want to retrieve (e.g., 'name,description,numberofemployees,industry'). Field names are case-sensitive and should match Salesforce API names. If unspecified, all accessible fields are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_RUN_REPORTRuns a report and returns the results. Creates a report instance that can be checked for completion. Results are returned in a nested structure (factMap, reportExtendedMetadata), not a flat record list; an empty factMap/rows is a valid result. Avoid repeated calls when freshness allows — reuse an existing instance_id instead.
Input parameters
The Salesforce ID of the report to run.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_RUN_SOQL_QUERYExecutes a SOQL query against Salesforce data. Returns records matching the query with pagination support.
Input parameters
SOQL query to execute. Must start with SELECT. Field names must match object schema exactly — use SALESFORCE_GET_ALL_FIELDS_FOR_OBJECT for unfamiliar objects. ALIASES: No 'AS' keyword (use 'SUM(Amount) TotalSales' NOT 'SUM(Amount) AS TotalSales'). AGGREGATES: Without GROUP BY, ORDER BY/LIMIT not allowed (single-row result). COUNT() SYNTAX: Bare COUNT() only valid alone. With GROUP BY or other fields, must specify field: COUNT(Id) or COUNT(fieldName). Example: 'SELECT COUNT(Id), Status FROM Lead GROUP BY Status' NOT 'SELECT COUNT(), Status FROM Lead GROUP BY Status'. NON-GROUPABLE: Long text, rich text, encrypted text, compound address/location fields. NON-FILTERABLE: Long text area, rich text, encrypted text, multi-select picklists, blob fields CANNOT be in WHERE. FIELDS(ALL)/FIELDS(CUSTOM) require LIMIT ≤200. ID values need single quotes. Apostrophes use backslash: 'O\\'Brien'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_SEARCHDEPRECATED: Use SALESFORCE_EXECUTE_SOSL_SEARCH instead. Executes a SOSL search query across multiple Salesforce objects. Use when you need to search for text across multiple object types simultaneously.
Input parameters
URL-encoded SOSL search query string to execute. Must follow SOSL syntax with FIND clause. Example: 'FIND {Acme} IN ALL FIELDS RETURNING Account(Name, Phone), Contact(FirstName, LastName)'
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_SEARCH_ACCOUNTSSearch for Salesforce accounts using criteria like name, industry, type, location, or contact information. Always provide at least one filter parameter; omitting all filters returns a broad, slow listing. Owner/territory filtering is unsupported — use SALESFORCE_RUN_SOQL_QUERY for ownership-based filters. Use SALESFORCE_GET_ACCOUNT to fetch complete field data for a specific record. Unsupported filter fields may be silently ignored — verify results reflect intended criteria.
Input parameters
Search by account name. Supports partial matches.
Search by account type. Note: The Type field may not exist in all Salesforce orgs. If the query fails with 'No such column Type', either omit this parameter or use a custom Type__c field if available in your org.
Maximum number of accounts to return. Results are hard-capped at approximately 2000 rows; use more selective filters if the full dataset exceeds this.
Search by phone number. Supports partial matches. Requires field-level security access to the Phone field.
Comma-separated list of valid Salesforce Account field API names to retrieve. Only use actual field names like Id, Name, Industry, etc. Do not include type annotations or placeholders like <string> or <DATE_TIME>. If any field in this list is restricted by field-level security, the entire request will fail — use a minimal set of standard fields (e.g., Id,Name,Website) when access is uncertain.
Search by website. Supports partial matches.
Search by industry.
Search by billing city. Supports partial matches.
Search by billing state/province. Supports partial matches.
Search by billing country. Supports partial matches.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_SEARCH_CAMPAIGNSSearch for Salesforce campaigns using multiple criteria like name, type, status, date range, or active status. Requires access to the Campaign object (Marketing User feature must be enabled in the org). For complex sorting (multi-field ORDER BY), use SALESFORCE_RUN_SOQL_QUERY instead.
Input parameters
Search by campaign name. Supports partial matches. Combine with type, status, or date range filters to narrow results when names are non-unique.
Search by campaign type.
Maximum number of campaigns to return. Check totalSize in the response to determine if results are truncated; issue additional queries if needed.
Comma-separated list of Campaign fields to retrieve.
Search by campaign status.
Filter by active status. True for active campaigns, False for inactive.
Upper bound for StartDate (inclusive). Use YYYY-MM-DD.
Lower bound for StartDate (inclusive). Use YYYY-MM-DD.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_SEARCH_CONTACTSSearch Salesforce Contact records (not Leads — use SALESFORCE_SEARCH_LEADS for those) using name, email, phone, account, or title. All parameters support partial/fuzzy matching, so results may include unrelated records; post-filter client-side for exact matches. Partial matches and common names can return multiple contacts — always confirm the correct contact by its 18-character Id before passing to write operations like SALESFORCE_LOG_CALL or SALESFORCE_CREATE_TASK. A response with totalSize=0 is a valid 'not found' outcome. Provide at least one search criterion; omitting all returns a broad, slow result set. Returned Ids are 18-character strings and must be used as-is in downstream tools.
Input parameters
Search by contact name (first name, last name, or full name). Supports partial matches.
Search by email address. Supports partial matches.
Maximum number of contacts to return. Maximum allowed is 2000; when totalSize exceeds limit, paginate to retrieve full results.
Search by phone number. Supports partial matches.
Search by job title. Supports partial matches.
Comma-separated list of Contact fields to retrieve. Custom and non-default fields are excluded unless explicitly listed here.
Search by associated account name. Supports partial matches.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_SEARCH_KNOWLEDGE_ARTICLESSearch for Salesforce Knowledge articles with titles matching the search query. Returns auto-suggest results for Knowledge articles based on title matches.
Input parameters
The user's search query string to match against article titles. This is the text that will be matched against Knowledge article titles.
Maximum number of suggested articles to return. Default: 5, Maximum: 10. Controls how many article suggestions are included in the response.
Knowledge article topic names to filter results. Provide topic names to narrow down the search to articles tagged with specific topics.
The channel for which the article is visible. Valid values: 'Pkb' (Public Knowledge Base), 'Csp' (Customer Portal), 'Prm' (Partner Portal), 'App' (Application).
The article language API name (e.g., 'en_US', 'fr_FR', 'de_DE'). Filters results to articles in the specified language. If not provided, returns articles in all languages.
The article publication status. Valid values: 'Draft', 'Online', 'Archived'. Filters results to articles with the specified publication status.
The article's validation status. Valid values: 'Draft', 'Validated', 'Published'. Filters results by the article's validation state.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_SEARCH_LEADSSearch for Salesforce leads using criteria like name, email, phone, company, title, status, or lead source. At least one search criterion should be provided — omitting all parameters results in a broad, slow listing of arbitrary records. Partial matches on name, email, and company may return multiple candidates; confirm Email or Company field values before using a lead ID in downstream operations.
Input parameters
Search by lead name (first name, last name, or full name). Supports partial matches.
Search by email address. Supports partial matches.
Maximum number of leads to return. Maximum cap is 2000; for result sets beyond 2000, use SALESFORCE_RUN_SOQL_QUERY with pagination via nextRecordsUrl.
Search by phone number. Supports partial matches.
Search by job title. Supports partial matches.
Comma-separated list of Lead fields to retrieve.
Search by lead status.
Search by company name. Supports partial matches.
Search by lead source.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_SEARCH_NOTESSearch for Salesforce notes using multiple criteria like title, body content, parent record, owner, or creation date. Provide at least one filter criterion — omitting all filters returns a broad, slow, noisy listing.
Input parameters
Search within note body content using full-text search (SOSL). When provided, body search is combined with any additional filters using AND logic.
Maximum number of notes to return. Maximum allowed value is 2000; apply precise filters or paginate when result sets may exceed the limit.
Search by note title. Supports partial matches.
Comma-separated list of Note fields to retrieve. Parent.Name may be null when the parent record is deleted or inaccessible.
Filter by private status. True for private notes, False for public notes. Private notes may be silently omitted if the integration user lacks permission — absence of results does not guarantee no notes exist.
Search by note owner's user name. Supports partial matches.
Search by parent record name (Account, Contact, Lead, Opportunity, Case, or custom objects). Supports partial matches. Searches across common parent object types to find matching records. Cannot filter by parent record ID or parent object type; use SALESFORCE_RUN_SOQL_QUERY for ID-scoped note lookups.
Filter notes created on or before this date (YYYY-MM-DD).
Filter notes created on or after this date (YYYY-MM-DD).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_SEARCH_OPPORTUNITIESSearch for Salesforce opportunities using multiple criteria like name, account, stage, amount, close date, or status. Apply at least one filter to avoid broad result sets. Partial-match searches may return multiple similar records; verify the correct record by Id before downstream use.
Input parameters
Search by opportunity name. Supports partial matches.
Maximum number of opportunities to return. Maximum value is 2000. When totalSize in the response exceeds limit, use nextRecordsUrl to paginate through the full dataset.
Comma-separated list of Opportunity fields to retrieve. Supports direct Opportunity fields (e.g., Id, Name, Amount) and parent relationship fields (e.g., Account.Name, Owner.Name). Note: Contact.* fields (Contact.Name, Contact.Email, etc.) are NOT valid because Opportunity does not have a direct parent relationship to Contact; use OpportunityContactRole queries to get contact information. Parent relationship fields like Account.Name may be null on returned records; guard against missing nested values when post-processing.
Filter by won status. True for won opportunities, False for lost (only applies to closed opportunities).
Filter by closed status. True for closed opportunities, False for open.
Maximum opportunity amount.
Minimum opportunity amount.
Search by opportunity stage.
Search by lead source.
Search by associated account name. Supports partial matches.
Search opportunities with close date before this date (YYYY-MM-DD).
Search opportunities with close date from this date (YYYY-MM-DD). When computing relative ranges (e.g., 'this week'), derive dates using the user's local timezone to avoid off-by-one-day errors.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_SEARCH_TASKSSearch for Salesforce tasks using multiple criteria like subject, status, priority, assigned user, related records, or dates. Always provide at least one filter criterion — no filters produces broad, slow results. For complex filtering not supported here, use SALESFORCE_RUN_SOQL_QUERY.
Input parameters
Maximum number of tasks to return. Maximum is 2000. When returned record count equals limit or nextRecordsUrl is present in the response, paginate to retrieve all matching tasks.
Comma-separated list of Task fields to retrieve. WhoId/Who.Name, WhatId/What.Name, OwnerId/Owner.Name, and Description can be null on Task records — guard against null before accessing nested .Name fields. Call-specific fields (CallType, CallDurationInSeconds) are frequently null and unreliable as sole filters.
Search by task status.
Search by task subject. Supports partial matches. Many Tasks are system-generated or email-related; combine with activity_date_from/activity_date_to, status, and priority for better precision.
Search by task priority.
Filter by closed status. True for completed tasks, False for open tasks.
Search by related account name. Supports partial matches.
Search by related contact name. Supports partial matches.
Search tasks with activity date before this date (YYYY-MM-DD).
Search by assigned user name. Supports partial matches.
Search tasks with activity date from this date (YYYY-MM-DD). Date filtering may not strictly bound results; verify ActivityDate in returned records when date accuracy matters.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_SEND_EMAILSends an email through Salesforce with options for recipients, attachments, and activity logging. Can partially succeed — check per-recipient success/failure status rather than treating the call as all-or-nothing. For large recipient lists, use SALESFORCE_SEND_MASS_EMAIL instead.
Input parameters
Body content of the email.
Whether the email body is HTML formatted.
Subject line of the email.
Whether to log the email on the recipient's activity timeline. Requires correct recipient_id and related_record_id values; incorrect IDs silently log the activity against the wrong records.
Type of sender.
CC email addresses. Can be a comma-delimited string or a list.
ID of a lead, contact, or person account to send the email to. Used for logging and merge fields.
Email addresses of recipients. Can be a comma-delimited string or a list. Recipients with null email fields generate per-recipient errors without failing the entire call; filter out null-email records beforehand.
BCC email addresses. Can be a comma-delimited string or a list.
IDs of files to attach. Provide ContentVersion (068...), Document (015...) Ids, or ContentDocument (069...) IdsCan be a comma-delimited string or a list.
Organization-wide email address. Required only when sender_type is OrgWideEmailAddress.
ID of a related record (e.g., Account, Opportunity, Case) for logging and merge fields.
Org-Wide Email Address Id to use when sender_type is OrgWideEmailAddress.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_SEND_EMAIL_FROM_TEMPLATESends an email using a predefined Salesforce email template with merge field support.
Input parameters
Whether to log the email on the recipient's activity timeline. Defaults to true for template emails.
Type of sender. Valid values: CurrentUser, DefaultWorkflowUser, OrgWideEmailAddress.
ID of the email template to use.
CC email addresses. Can be a comma-delimited string or a list.
ID of the lead, contact, or person account to send the email to. Required when using templates.
BCC email addresses. Can be a comma-delimited string or a list.
IDs of files to attach. Can be a comma-delimited string or a list.
Organization-wide email address. Required only when sender_type is OrgWideEmailAddress.
ID of a related record (e.g., Case, Opportunity) to populate merge fields from a different object.
Whether to add threading tokens for email-to-case or custom threading. Useful for case-related emails.
Additional email addresses to send to (besides the recipient). Can be a comma-delimited string or a list.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_SEND_MASS_EMAILSends bulk emails to multiple recipients immediately and irreversibly using a template or custom content. Requires either a valid template_id or both subject and body; omitting all three causes errors. Processes in batches for performance. Check failedRecipients and summary.failureCount in the response even when success=true, as individual recipient failures can occur without an overall failure.
Input parameters
Body content of the email. Required if template_id is not provided.
Whether the email body is HTML formatted. Only applies when not using a template.
Subject line of the email. Required if template_id is not provided.
Number of recipients to process in each batch. Maximum is 150.
Whether to log the emails on each recipient's activity timeline.
Type of sender.
ID of the email template to use. If not specified, subject and body must be provided.
List of IDs for leads, contacts, or person accounts to send emails to. Maximum 150 recipients per call. All recipient records must have a non-null Email field; null emails generate per-recipient errors.
Organization-wide email address. Required only when sender_type is OrgWideEmailAddress.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_SET_USER_PASSWORDTool 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.
Input parameters
The Salesforce User ID for which to set the password. Must be a valid 15 or 18-character Salesforce User ID.
The new password to set for the user. If omitted, Salesforce will generate and return a random password. The password must meet the organization's password policies including length and complexity requirements.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_SOBJECT_ROWS_UPDATETool 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.
Input parameters
Dictionary of field name/value pairs to update. Only include fields that need to be updated. Field names must match the API names of the sObject fields (e.g., 'Phone', 'Name', 'CustomField__c'). Field names are case-sensitive.
The unique 15 or 18-character Salesforce ID of the record to update.
The API name of the Salesforce object type to update (e.g., Account, Contact, Opportunity, CustomObject__c). Case-sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_SOBJECT_USER_PASSWORDTool to check whether a Salesforce user's password has expired. Use when you need to verify password expiration status for a specific user.
Input parameters
The 15 or 18-character Salesforce User ID to check password expiration status for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_TOOLING_QUERYTool 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.
Input parameters
The SOQL query to execute against Tooling API metadata objects. Example: 'SELECT Id, Name FROM ApexClass LIMIT 10'. Can query metadata objects like ApexClass, ApexTrigger, ValidationRule, WorkflowRule, FieldDefinition, EntityDefinition, etc. Supports standard SOQL syntax including WHERE, ORDER BY, LIMIT, and OFFSET clauses. Maximum OFFSET value is 2000 when using pagination with LIMIT/OFFSET.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_ACCOUNTUpdates an existing account in Salesforce with the specified changes. Only provided fields will be updated.
Input parameters
Updated fax number. Leave empty to keep unchanged.
Updated account name. Leave empty to keep unchanged.
Updated account type. Leave empty to keep unchanged.
Updated phone number. Leave empty to keep unchanged.
Updated website URL. Leave empty to keep unchanged.
Updated industry. Leave empty to keep unchanged.
Updated SIC description. Leave empty to keep unchanged.
Updated parent account ID. Leave empty to keep unchanged.
The Salesforce ID of the account to update.
Updated description. Leave empty to keep unchanged.
Updated billing city. Leave empty to keep unchanged.
Updated billing state. Leave empty to keep unchanged. If your org has State and Country/Territory picklists enabled, provide the exact picklist value (e.g., 'California' instead of 'CA').
Dictionary of custom field API names and their values. Custom field names typically end with '__c' (e.g., 'Level__c', 'Languages__c'). Values can be strings, numbers, booleans, or null depending on the field type.
Updated shipping city. Leave empty to keep unchanged.
Updated account source. Leave empty to keep unchanged.
Updated annual revenue. Leave empty to keep unchanged.
Updated billing street. Leave empty to keep unchanged.
Updated shipping state. Leave empty to keep unchanged.
Updated billing country. Leave empty to keep unchanged. If your org has State and Country/Territory picklists enabled, provide the exact picklist value (e.g., 'United States' instead of 'USA').
Updated shipping street. Leave empty to keep unchanged.
Updated shipping country. Leave empty to keep unchanged.
Updated billing postal code. Leave empty to keep unchanged.
Updated number of employees. Leave empty to keep unchanged.
Updated shipping postal code. Leave empty to keep unchanged.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_ACCOUNT_OBJECT_BY_IDDEPRECATED: 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.
Input parameters
Unique identifier (ID) of the Account object to be updated (e.g., '001R0000005hDFYIA2').
Fax number (max 40 chars).
SIC code for business accounts (max 20 chars).
Name of the account (max 255 chars). For Person Accounts, this is a concatenated field (FirstName, MiddleName, LastName, Suffix) and not directly modifiable here.
Account site/location name (e.g., Headquarters, max 80 chars).
Type of account (picklist).
Primary phone number (max 40 chars).
Data.com (Jigsaw) company ID reference (max 20 chars). Typically managed by Data.com integration.
Account prospect rating (picklist).
Custom field: Service Level Agreement (SLA) information.
ID of the user owning this account. Defaults to current user on creation. Requires permission to change.
SIC code description for business accounts (max 80 chars).
Account website (fully qualified URL, max 255 chars).
Primary industry (picklist, max 40 chars).
ID of the parent account, if any.
Path for social network profile image URL. Typically read-only.
Custom field: Indicates if the account is active.
Indicates if the object is in the Recycle Bin. Typically read-only for updates.
NAICS code for business accounts (6 digits, max 8 chars total). Typically requires Data.com.
NAICS code description for business accounts (max 120 chars). Typically requires Data.com.
Ownership type (picklist).
D-U-N-S number for business accounts (9 digits). Typically requires Data.com.
Tradestyle or 'DBA' name for business accounts (max 255 chars). Typically requires Data.com.
Billing city (max 40 chars).
Data quality status compared with Data.com (e.g., Matched, Pending). Typically managed by Data.com Clean.
ID of the user who created the account (read-only).
Creation date and time (read-only).
Text description (max 32,000 chars; 255 in reports).
Year organization was established for business accounts (4 chars). Typically requires Data.com.
Billing state/province (max 80 chars).
Shipping city (max 40 chars).
Stock market symbol for business accounts (max 20 chars).
Account number (not the system ID, max 40 chars).
Source of the account record (picklist, max 40 chars).
Estimated annual revenue.
Billing street address.
Shipping state/province (max 80 chars).
Dictionary of custom field API names and their values. Custom field names typically end with '__c'.
Billing country (max 80 chars).
D&B Company ID for Dun & Bradstreet integration (typically read-only).
Timestamp of last view by current user (read-only).
ID of the master record if this account was merged and deleted; null otherwise. Typically read-only.
Shipping street address (max 255 chars).
System modification timestamp (read-only).
Latitude for billing address (-90 to 90, up to 15 decimal places). Part of BillingAddress compound field.
Jigsaw company ID (read-only, for Data.com integration).
Shipping country (max 80 chars).
URL for the Salesforce SObject. Read-only, ignored in updates.
Longitude for billing address (-180 to 180, up to 15 decimal places). Part of BillingAddress compound field.
Most recent activity date (read-only).
ID of the user who last modified the account (read-only).
Last modification date and time (read-only).
ID of operating hours associated with the account. Requires Field Service to be enabled.
Latitude for shipping address (-90 to 90, up to 15 decimal places). Part of ShippingAddress compound field.
Salesforce SObject type (e.g., 'Account'). Read-only, ignored in updates.
Billing postal code (max 20 chars).
Number of employees (max 8 digits).
Longitude for shipping address (-180 to 180, up to 15 decimal places). Part of ShippingAddress compound field.
Timestamp of last access by current user (read-only).
Custom field: SLA serial number.
Shipping postal code (max 20 chars).
Custom field: Customer priority.
Custom field: Number of locations for the account.
Custom field: SLA expiration date.
Custom field: Potential upsell opportunities.
Geocode accuracy for billing address. Part of BillingAddress compound field.
Geocode accuracy for shipping address. Part of ShippingAddress compound field.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_CAMPAIGNUpdates an existing campaign in Salesforce with the specified changes. Only provided fields will be updated.
Input parameters
Updated campaign name. Leave empty to keep unchanged.
Updated campaign type. Leave empty to keep unchanged.
Updated campaign status. Leave empty to keep unchanged.
Updated end date in YYYY-MM-DD format. Leave empty to keep unchanged.
Updated active status. Leave as None to keep unchanged.
Updated parent campaign ID. Leave empty to keep unchanged.
Updated start date in YYYY-MM-DD format. Leave empty to keep unchanged.
Updated actual cost. Leave unset to keep unchanged.
The Salesforce ID of the campaign to update.
Updated description. Leave empty to keep unchanged.
Updated number sent. Leave unset to keep unchanged.
Updated budgeted cost. Leave unset to keep unchanged.
Custom fields to update on the campaign. Use API field names (ending in __c). Leave empty if not updating custom fields.
Updated expected revenue. Leave unset to keep unchanged.
Updated expected response rate. Leave unset to keep unchanged.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_CAMPAIGN_BY_ID_WITH_JSONDEPRECATED: Updates specific fields of an existing Campaign in Salesforce, identified by its unique `id`, which must already exist.
Input parameters
Unique identifier of the Campaign to update (e.g., 001R0000005hDFYIA2).
Name of the campaign (max 80 characters).
Type of campaign (limit 40 characters).
Status of the campaign (limit 40 characters).
Campaign end date (YYYY-MM-DD); responses received after this date are still counted.
ID of the campaign owner; defaults to the API caller if not specified.
Indicates if the campaign is active. Label: Active.
ID of the parent Campaign if part of a hierarchy.
Read-only. Indicates if the record has been deleted.
Campaign start date (YYYY-MM-DD).
Actual cost of the campaign.
Number of individuals targeted (e.g., emails sent). Label: Num Sent.
Read-only. ID of the creator.
Read-only. Creation date and time.
Campaign description (limit 32KB; first 255 chars displayed in reports).
Budgeted cost for the campaign.
Read-only. Total leads in the campaign. Label: Leads in Campaign.
Dictionary of custom field API names and their values. Custom field names typically end with '__c'.
Read-only. Timestamp of the current user's last view.
Read-only. Timestamp of the last system modification.
Expected revenue from the campaign.
Read-only. API URL for this Campaign object.
Expected response rate percentage (e.g., 10 for 10%).
Read-only. Date of the last activity (event or closed task).
Read-only. ID of the last modifier.
Read-only. Last modification date and time.
Read-only. Total contacts in the campaign. Label: Total Contacts.
Read-only. Salesforce object type, typically 'Campaign'.
Read-only. Number of 'Responded' members. Label: Responses in Campaign.
Read-only. Timestamp of the current user's last reference.
Read-only. Total opportunities in the campaign. Label: Opportunities in Campaign.
Read-only. Total value of all opportunities. Label: Value Opportunities in Campaign.
Read-only. Total value of won opportunities. Label: Value Won Opportunities in Campaign.
Read-only. Number of converted leads. Label: Converted Leads.
Read-only. Number of won opportunities. Label: Won Opportunities in Campaign.
Record type ID for CampaignMember records, used to differentiate member types.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_CONTACTUpdates an existing contact in Salesforce with the specified changes. Only provided fields will be updated. Returns HTTP 204 with no body on success; use SALESFORCE_GET_CONTACT to verify applied changes. Org-level validation rules, duplicate rules, or field-level permissions may reject correctly formatted requests with HTTP 400; inspect the error response to identify the constraint.
Input parameters
Updated email address. Leave empty to keep unchanged.
Updated primary phone number. Leave empty to keep unchanged.
Updated job title. Leave empty to keep unchanged.
Updated birthdate in YYYY-MM-DD format. Leave empty to keep unchanged.
Updated last name. Leave empty to keep unchanged.
Updated Account ID association. Leave empty to keep unchanged. Alternatively use SALESFORCE_ASSOCIATE_CONTACT_TO_ACCOUNT, but prefer setting this field when updating multiple fields simultaneously.
The Salesforce ID of the contact to update. Must be a valid 18-character Salesforce ID (retrieve via SALESFORCE_SEARCH_CONTACTS); names or emails cannot substitute.
Updated department. Leave empty to keep unchanged.
Updated first name. Leave empty to keep unchanged.
Updated mailing city. Leave empty to keep unchanged.
Updated mobile phone number. Leave empty to keep unchanged.
Dictionary of custom field API names and their values. Custom fields in Salesforce end with '__c' (e.g., 'Level__c', 'Languages__c').
Updated mailing state/province. Leave empty to keep unchanged.
Updated mailing street address. Leave empty to keep unchanged.
Updated mailing country. Leave empty to keep unchanged.
Updated mailing postal/zip code. Leave empty to keep unchanged.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_CONTACT_BY_IDDEPRECATED: Updates specified fields of an existing Salesforce Contact by its ID; at least one field must be provided for modification.
Input parameters
Unique Salesforce ID of the Contact to update (e.g., '001R0000005hDFYIA2'). This is a required path parameter.
Business fax number. Label: 'Business Fax'.
Full name (read-only). Concatenation of FirstName, MiddleName, LastName, Suffix.
Email address.
Primary business phone. Label: 'Business Phone'.
Job title (e.g., CEO, Vice President).
Data.com (Salesforce D&B) company ID. Max 20 chars. Do not modify; used for import troubleshooting.
Salesforce User ID of the contact owner.
Contact's last name, up to 80 characters.
Custom field 'Level__c': Categorizes contact importance/engagement (e.g., Primary).
Relative path to profile photo (read-only). Combine with instance URL for full path. Empty if Social Accounts/Contacts is disabled.
Parent Account ID. When changing accounts for portal-enabled contacts, update up to 50 contacts at once, preferably after business hours.
Birthdate (YYYY-MM-DD). Year is ignored in report/SOQL filters.
Contact's first name, up to 40 characters.
Home telephone number.
Indicates if the contact is in the Recycle Bin. Label: 'Deleted'.
Alternative address: city.
Department.
Lead source (e.g., Web, Partner Referral).
Alternative address: phone number.
Alternative address: state/province.
Honorific for greetings (e.g., Mr., Ms., Dr.).
Data quality status compared to Data.com (e.g., 'Matched', 'Pending').
ID of the user who created the contact (read-only).
Creation date/time (read-only).
Description (up to 32KB). Label: 'Contact Description'.
Mailing address: city.
Mobile phone number.
Alternative address: street.
Manager's Contact ID. Not available if IsPersonAccount is true.
Associated data privacy record ID. Available if Data Protection and Privacy is enabled.
Custom field 'Languages__c': Languages spoken by the contact (e.g., English;Spanish).
Mailing address: state/province.
Alternative address: country.
Assistant's name.
Source of contact information (e.g., external system).
Mailing address: street.
Alternative address: latitude (–90 to 90, up to 15 decimal places). Use with OtherLongitude.
Dictionary of custom field API names and their values. Custom field names typically end with '__c'.
Assistant's telephone number.
Indicates if an email to the contact has bounced, if bounce management is active.
Timestamp of when current user last viewed this contact; null if only referenced (read-only).
Mailing address: country.
ID of the master record if this contact was merged and deleted; null otherwise.
Alternative address: longitude (–180 to 180, up to 15 decimal places). Use with OtherLatitude.
Last system modification date/time (read-only).
Data.com contact ID (read-only). Used for internal sync; do not modify.
Mailing address: latitude (–90 to 90, up to 15 decimal places). Use with MailingLongitude.
Alternative address: postal code.
Relative API URL for this SObject. Typically read-only, not for update requests.
Date/time of email bounce, if bounce management is active.
Indicates if this is a priority contact.
Date of the most recent activity or closed task (read-only).
Timestamp of the last contact update for data privacy (read-only).
ID of the user who last modified the contact (read-only).
Last modification date/time (read-only).
Mailing address: longitude (–180 to 180, up to 15 decimal places). Use with MailingLatitude.
Salesforce SObject type (e.g., 'Contact'). Typically read-only, not for update requests.
Timestamp of the last contact update request for data privacy (read-only).
Mailing address: postal code.
Reason for email bounce, if bounce management is active.
Timestamp of when current user last accessed this contact or related records (read-only).
Alternative address: geocode accuracy.
Mailing address: geocode accuracy.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_FAVORITETool to update a favorite's properties in Salesforce UI API. Use when you need to reorder favorites or modify their display properties.
Input parameters
The display name of the favorite. Update this to change how the favorite appears in the list.
The display order/position of the favorite in the user's favorites list. Lower numbers appear first. Used to reorder favorites.
The unique 15 or 18-character Salesforce ID of the favorite to update.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_LEADUpdates an existing lead in Salesforce with the specified changes. Only provided fields will be updated.
Input parameters
Updated city. Leave empty to keep unchanged.
Updated email address. Leave empty to keep unchanged.
Updated phone number. Leave empty to keep unchanged.
Updated state/province. Leave empty to keep unchanged.
Updated job title. Leave empty to keep unchanged.
Updated rating. Leave empty to keep unchanged. Must match a valid picklist value configured in the org; invalid values cause a validation error. Represents lead quality (Hot/Warm/Cold), not pipeline stage.
Updated status. Leave empty to keep unchanged. Must match a valid picklist value configured in the org; invalid values cause a validation error. Represents pipeline stage, not lead quality rating.
Updated street address. Leave empty to keep unchanged.
Updated company name. Leave empty to keep unchanged.
Updated country. Leave empty to keep unchanged.
The Salesforce ID of the lead to update.
Updated website. Leave empty to keep unchanged.
Updated industry. Leave empty to keep unchanged.
Updated last name. Leave empty to keep unchanged.
Updated first name. Leave empty to keep unchanged.
Updated description. Leave empty to keep unchanged.
Updated lead source. Leave empty to keep unchanged.
Updated postal/zip code. Leave empty to keep unchanged.
Custom fields to update on the lead. Pass a dictionary where keys are the Salesforce API names of custom fields (e.g., 'Level__c', 'Languages__c') and values are the field values to set. Custom field names typically end with '__c'.
Updated annual revenue. Leave unset to keep unchanged. Negative values are passed through to Salesforce as-is (useful for adjustments/write-offs).
Updated number of employees. Leave unset to keep unchanged.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_LEAD_BY_ID_WITH_JSON_PAYLOADDEPRECATED: 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.
Input parameters
Unique Salesforce ID of the Lead to update (e.g., 001R0000005hDFYIA2); this is a required path parameter.
Fax number.
City for the lead's address.
Read-only full name of the lead (concatenation of FirstName, MiddleName, LastName, Suffix; max 203 characters).
Email address.
Primary phone number.
State or province (e.g., CA, California).
Lead's job title.
Data.com (Jigsaw) contact ID reference (max 20 chars). Indicates Data.com import. Do not modify. Label: Data.com Key.
Lead rating (e.g., potential or priority).
Current status (e.g., Open, Contacted); defined in LeadStatus picklist.
Street address (e.g., 123 Main St).
Required. Company the lead works for. If person accounts are enabled and Company is null, the lead converts to a person account.
Country for the lead's address.
Salesforce User ID of the lead owner.
Website URL.
Primary industry of the lead's company.
Lead's last name (up to 80 characters).
WGS84 latitude in decimal degrees (-90.0 to 90.0, up to 15 decimal places).
Relative URL path to the lead's photo; combine with Salesforce instance URL for full image URL. Empty if Social Accounts and Contacts is disabled.
Lead's first name (up to 40 characters).
Specifies if the Lead is in the Recycle Bin. Label: Deleted.
WGS84 longitude in decimal degrees (-180.0 to 180.0, up to 15 decimal places).
Source of the lead.
Postal code (e.g., ZIP code). Label: Zip/Postal Code.
Custom field, often indicating primary contact status.
Custom field for Standard Industrial Classification (SIC) code.
Lead's salutation.
Data cleanliness status compared with Data.com (e.g., Matched/In Sync, Acknowledged/Reviewed).
Read-only ID of the user who created the lead.
Read-only creation timestamp (ISO 8601).
Free-text description or notes (up to 32,000 characters).
Read-only flag indicating if the lead has been converted. Label: Converted.
Mobile phone number.
ID of the associated Individual (data privacy) record. Available if Data Protection and Privacy is enabled.
Annual revenue of the lead's company.
Read-only date of lead conversion (YYYY-MM-DD).
Dictionary of custom field API names and their values. Custom field names typically end with '__c'.
Typically read-only D&B Company ID used by Data.com.
Read-only timestamp of when the current user last viewed this lead (ISO 8601).
ID of the master Lead record if this Lead was merged and deleted; `null` otherwise.
Read-only timestamp of last system modification (ISO 8601).
Accuracy level of the geocoded address, specific to Salesforce's geocoding service.
Specifies if the lead is unread by its owner. Label: Unread By Owner.
Typically read-only Data.com (Jigsaw) contact ID for integration.
API URL for this Lead record. Generally not set by user for simple updates.
Date and time of email bounce (ISO 8601), if bounce management is active.
Indicates if this is a priority record; meaning varies by Salesforce customization.
Read-only most recent activity date (YYYY-MM-DD).
Read-only ID of the user who last modified the lead.
Read-only last modification timestamp (ISO 8601).
Salesforce sObject type (e.g., 'Lead'). Generally not set by user for simple updates.
Company D-U-N-S number (max 9 chars). Requires Data.com Prospector/Clean.
Number of employees at the lead's company. Label: Employees.
Read-only Salesforce ID of the Account created from this lead.
Read-only Salesforce ID of the Contact created from this lead.
Reason for email bounce, if bounce management is active.
Read-only timestamp of when the current user last accessed this lead or related record (ISO 8601).
Custom field for lead's product interest.
Custom field, possibly detailing current solutions or 'generators' used.
Custom field for the number of locations of the lead's company.
Read-only Salesforce ID of the Opportunity created from this lead.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_LIST_VIEW_PREFERENCESTool 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.
Input parameters
Maps field API names to boolean values indicating whether text should wrap to multiple lines (true) or be truncated (false).
Defines the left-to-right display order of columns using field API names.
Maps field API names to their desired display widths in pixels. Only include columns you want to resize.
The API name of the Salesforce object (e.g., 'Account', 'Lead', 'Contact').
The API name of the specific list view (e.g., 'AllAccounts', 'MyLeads').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_NOTEUpdates an existing note in Salesforce with the specified changes. Only provided fields will be updated.
Input parameters
Updated body/content of the note. Leave empty to keep unchanged.
Updated title of the note. Leave empty to keep unchanged.
The Salesforce ID of the note to update.
Updated owner ID. Leave empty to keep unchanged.
Updated privacy setting. Leave empty to keep unchanged.
Custom fields to update on the note. Keys should be the API names of custom fields (e.g., 'Custom_Field__c'). Values can be strings, numbers, booleans, or null.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_OPPORTUNITYUpdates an existing opportunity in Salesforce with the specified changes. Only provided fields will be updated. Returns HTTP 204 with empty body on success; call SALESFORCE_GET_OPPORTUNITY afterward to read updated values. Updates may fail with FIELD_CUSTOM_VALIDATION_EXCEPTION or REQUIRED_FIELD_MISSING — inspect the error message to identify the offending field.
Input parameters
Updated opportunity name. Leave empty to keep unchanged.
Updated opportunity type. Leave empty to keep unchanged.
Updated amount. Leave unset to keep unchanged. Negative values are passed through to Salesforce as-is.
Updated next step. Leave empty to keep unchanged.
Updated Account ID. Leave empty to keep unchanged.
Updated close date in YYYY-MM-DD format. Leave empty to keep unchanged.
Updated stage. Leave empty to keep unchanged. Must exactly match a stage defined in the org's current sales process; use SALESFORCE_GET_ALL_FIELDS_FOR_OBJECT with object_name='Opportunity' to discover valid values.
Updated description. Leave empty to keep unchanged.
Updated lead source. Leave empty to keep unchanged.
Updated probability percentage (0-100). Leave unset to keep unchanged.
Dictionary of custom field API names and their values to update. Use the exact API name ending with '__c'. IMPORTANT for lookup/reference fields: Fields that reference other records (e.g., Contact__c, User__c, Account__c) require a valid 18-character Salesforce record ID (e.g., '003XXXXXXXXXXXXXXX' for Contact, '005XXXXXXXXXXXXXXX' for User), NOT descriptive names or text. Passing names like 'John Smith' instead of IDs will fail with MALFORMED_ID error. IMPORTANT for picklist fields: Restricted picklists only accept predefined values from the Salesforce org. Use SALESFORCE_GET_ALL_FIELDS_FOR_OBJECT with object_name='Opportunity' to discover field types and valid values.
The Salesforce ID of the opportunity to update. Multiple opportunities may share the same name — apply additional filters (stage, owner, account) or confirm with the user before updating to avoid modifying the wrong record. Use IDs from fresh search results; stale or manually constructed IDs may be invalid.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_OPPORTUNITY_BY_IDDEPRECATED: 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.
Input parameters
Unique Salesforce ID of the Opportunity to update (e.g., 006P0000004iVBDIA2).
Name for this opportunity. Max 120 characters.
Type of opportunity (e.g., 'New Business', 'Existing Customer'). Label: Opportunity Type.
Read-only. Indicates if won. Controlled by StageName. Label: Won.
Estimated total sale amount. If the opportunity has products, this amount is the sum of the related products and direct updates to this field are ignored.
If fiscal years are not enabled: name of the fiscal quarter/period for CloseDate (Format: "YYYY Q", e.g., "2023 1").
ID of the User owner. Updating may change previous owner's record access. Requires 'Transfer Record' permission (API v16.0+).
Read-only. Indicates if closed. Controlled by StageName. Label: Closed.
Next task in closing the opportunity. Max 255 characters.
ID of the associated Account, which must exist in Salesforce.
Expected close date in YYYY-MM-DD format.
Read-only. ID of primary Contact, derived from OpportunityContactRole. Set at creation via IsPrimary flag on OpportunityContactRole (API v46.0+).
Indicates if the object is in the Recycle Bin. Label: Deleted.
If true, the opportunity is private, visible only to the owner and administrators.
Number of times this record has been synchronized with a mobile device. Used by Salesforce mobile applications.
Current stage (e.g., 'Prospecting'). Updating automatically updates ForecastCategoryName, IsClosed, IsWon, and Probability. Query OpportunityStage object for available names.
ID of a related Campaign. Requires Campaigns feature enabled and read access to the Campaign object.
Fiscal year of the CloseDate (e.g., 2024), based on organization's fiscal year settings.
Source of this opportunity (e.g., 'Advertisement', 'Trade Show').
Read-only. ID of the user who created this record.
Read-only. Creation timestamp (ISO 8601 UTC).
Text description of the opportunity. Max 32,000 characters.
Estimated confidence percentage (0-100) in closing. Usually implied by StageName, but can be overridden. Round decimal probabilities to whole numbers.
ID of the associated Pricebook2. Required to add line items if products are enabled. Cannot update if line items exist.
Fiscal quarter (1-4) of the CloseDate, based on organization's fiscal year settings.
Dictionary of custom field API names and their values. Custom field names typically end with '__c'.
Read-only. True if opportunity has an overdue task (API v35.0+).
Read-only. Timestamp current user last viewed this record (ISO 8601 UTC). Null if only referenced (LastReferencedDate).
Order number associated with the opportunity.
Read-only. Last system modification timestamp (ISO 8601 UTC), by user or automation.
Read-only. Calculated as Amount * Probability. Updated by changes to Amount or Probability.
Read-only. True if opportunity has an open event or task (API v35.0+).
Relative URL of the SObject record in Salesforce. Generally Salesforce-provided.
Forecast category (e.g., 'Pipeline', 'BestCase'). Implied by StageName but can be overridden. In API v12.0+, value is set via ForecastCategoryName.
Read-only. Due date of most recent event or last closed task (YYYY-MM-DD).
Read-only. ID of the user who last modified this record.
Read-only. Last modification timestamp (ISO 8601 UTC).
Type of the Salesforce SObject (e.g., 'Opportunity'). Generally Salesforce-provided.
Tracking number related to the opportunity.
Read-only. Timestamp current user last accessed this record or a related record (ISO 8601 UTC).
Main competitors for this opportunity.
Read-only. Timestamp of last stage change (ISO 8601 UTC).
Information about current generators related to the opportunity.
API v12.0+. Name of the forecast category (e.g., 'Pipeline'). Implied by StageName but can be overridden.
Read-only. True if opportunity has line items (Products). Requires assigned Pricebook to add line items.
Number of items in this opportunity. Used in quantity-based forecasting.
Read-only. ID of OpportunityHistory record for last Amount update (API v50.0+).
Delivery and installation status of the opportunity.
Read-only. ID of OpportunityHistory record for last CloseDate update (API v50.0+).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_RECORDTool 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.
Input parameters
Map of field API names to their new values. Only include fields you want to update. Field names should use API names (e.g., 'FirstName', 'Email', 'CustomField__c'). Unspecified fields remain unchanged.
The API name of the record's object type (e.g., 'Contact', 'Account', 'Lead'). Can be null or omitted for updates.
The unique 15 or 18-character Salesforce ID of the record to update.
Case, Lead, and Account objects only. If true, applies assignment and auto-response rules. Default is false.
Case and Lead objects only. If true, sends email notifications to users in the organization. Default is false.
RFC 7231 date/time format. Makes the request conditional - server will only update if the record hasn't been modified since this timestamp. Returns 412 Precondition Failed if the record was modified after this date.
Case object only. If true, sends email notifications outside the organization. Default is false.
If true, allows the record to be saved even if duplicate detection rules are triggered. Default is false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_RELATED_LIST_PREFERENCESTool to update user preferences for a specific related list on an object in Salesforce. Use when customizing display settings such as column widths, text wrapping, column ordering, and sorting preferences for related lists.
Input parameters
Array of sort preference objects defining field sorting order. Each object specifies a field and sort direction.
Text wrapping preferences for columns, mapping field API names to boolean wrap settings. Set to true to enable text wrapping for that column, false to disable.
User-defined column width preferences mapping field API names to pixel widths. Use this to customize how wide each column appears in the related list.
The composite layout name in format {objectApiName}.{relatedListId}. This identifies which related list on which object to update preferences for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_SPECIFIC_NOTE_BY_IDDEPRECATED: 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.
Input parameters
The 18-character Salesforce ID of the Note SObject to be updated. This is a required path parameter. (Note: actual Note IDs typically start with `002`).
Content or body of the Note. Limited to 32 KB.
Title of the Note.
The 18-character Salesforce ID of the User who owns the Note. Updating this changes Note ownership.
ID of the parent SObject (e.g., Account, Contact, Opportunity) to which this Note is related; can be updated. Salesforce Note objects often require a `ParentId`.
Indicates whether the Note has been moved to the Recycle Bin (`true`) or not (`false`). Set to `true` to soft-delete. Label: `Deleted`.
Controls Note visibility. If `true`, Note is private (accessible only by owner or users with 'Modify All Data'). If `false` (default), visibility based on sharing rules. Note: users without 'Modify All Data' setting this `true` on a non-owned note might lose access. Label: `Private`.
Salesforce ID of the User who created the Note (Salesforce field `CreatedById`). System-generated, read-only, and not updatable.
Timestamp of Note creation (Salesforce field `CreatedDate`). System-generated, read-only, and not updatable through this action.
Dictionary of custom field API names and their values. Custom field names typically end with '__c'.
Timestamp of Note record's last modification by user or system (Salesforce field `SystemModstamp`). System-generated, read-only, not updatable.
Relative URL for the SObject record. System-managed metadata, not part of an update request.
Salesforce ID of the User who last modified the Note (Salesforce field `LastModifiedById`). System-generated, read-only, and not updatable.
Timestamp of Note's last modification (Salesforce field `LastModifiedDate`). System-generated, read-only, and not updatable.
Type of the SObject, typically 'Note'. System-managed metadata, not part of an update request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPDATE_TASKUpdates an existing task in Salesforce with new information. Only provided fields will be updated.
Input parameters
Updated status. Leave empty to keep unchanged.
Updated Contact or Lead ID. Leave empty to keep unchanged.
Updated subject/title of the task. Leave empty to keep unchanged.
The Salesforce ID of the task to update.
Updated related record ID. Leave empty to keep unchanged.
Updated priority level. Leave empty to keep unchanged.
Updated description or notes. Leave empty to keep unchanged.
Updated due date in YYYY-MM-DD format. Leave empty to keep unchanged.
Dictionary of custom field API names and their values. Custom field names typically end with '__c' (e.g., 'Priority_Level__c': 'High').
Whether to set/unset a reminder. Leave empty to keep unchanged.
Updated reminder date/time in ISO format. Leave empty to keep unchanged.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPLOAD_FILEUpload 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.
Input parameters
Description of the file to help users understand its content.
File to upload to Salesforce Files home. Either 'file' or 'filename' + 'content_b64' must be provided.
The title/name of the file in Salesforce. If not specified, the filename from the uploaded file will be used.
the name of the file (e.g., 'document.pdf'). Must be used together with 'content_b64'.
Base64-encoded file content. Must be used together with 'filename'.
MIME type for the file when using filename/content_b64. Defaults to 'application/octet-stream' if not provided.
The ID of the record to associate the file with (typically an 18-character Salesforce ID). If not specified, the file is uploaded to the user's personal library. Can be Account, Contact, Lead, Opportunity, or other record IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPLOAD_JOB_DATATool 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.
Input parameters
The unique identifier of the Bulk API v2 ingest job to upload data to. This is the job ID returned from job creation.
The CSV-formatted data to upload. First row must contain column headers matching Salesforce object field names. Subsequent rows contain the data records. Line endings must match the lineEnding parameter specified during job creation (LF or CRLF).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SALESFORCE_UPSERT_SOBJECT_BY_EXTERNAL_IDTool 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.
Input parameters
JSON object containing the fields to create or update. Field names should be the Salesforce API names with their corresponding values.
The API name of the Salesforce object (e.g., Account, Contact, CustomObject__c).
The API name of the external ID field. This field must be marked as 'External ID' in Salesforce.
The value of the external ID for the specific record to upsert.
Available in API v62.0+. When set to true, only updates existing records without creating new ones. Returns 404 if record doesn't exist.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
No publicly available marketplace agent is found using this tool yet. There are 33 agents privately built on Nagent that already use Salesforce.
Build on Nagent
Connect Salesforce to any Nagent agent in minutes — no API key management, no boilerplate. Just configure and deploy.
The five questions agent builders ask before adopting a new integration.
Open the External Integrations panel inside Nagent (app.nagent.ai/externalIntegration), find Salesforce, and click "Connect Now." You'll authenticate with OAUTH2, S2S_OAUTH2 — Nagent handles credential storage and refresh automatically. Once connected, Salesforce is available to any agent in your workspace.
No. Nagent provides no-code integration for every tool. Once Salesforce is connected, you configure its 216 actions and 7 triggers directly in the agent builder UI — no API calls, no boilerplate, no schema management.
Helix — Nagent's agentic agent builder — lets you drop Salesforce steps into any workflow visually. Pick an action (e.g., one of those listed above), fill in the inputs (Helix knows the required vs. optional schema for each parameter), and connect it to upstream/downstream steps. Triggers run as the entry point of an agent, so when a Salesforce event fires, the agent kicks off automatically.
Every Salesforce action and trigger ships with a fully-typed schema — input parameters with name, type, required flag, and description, plus the output payload shape. The schemas are documented in the sections above. Helix uses these schemas to validate your configuration at build time and to type-check the data flowing between steps.
Yes. While Salesforce ships with 216 pre-built crm actions, you can layer custom logic around them inside Helix — pre/post-processing steps, conditional branches, retries, or stitching Salesforce together with other connected tools. For deeper customization, talk to our team about Nagent's Agentic AI Lab — forward-deployed engineers who build Salesforce-based workflows tailored to your business.