Use Salesforce in Sim to manage accounts, contacts, leads, opportunities, cases, and tasks, run reports and SOQL queries, and create custom fields and objects through the Tooling API.

Connection guides: Integration users.

OAuth scopes

Sim requests these scopes when someone connects a Salesforce account. For a self-hosted deployment, register your own app with the provider using the settings below. See Integrations and OAuth for setup.

Use the block

Manage accounts, contacts, leads, opportunities, cases, and tasks, run reports and SOQL queries, and manage org schema by creating custom fields and objects via the Tooling API.

Actions

Get Accounts from Salesforce

Retrieve accounts from Salesforce CRM

Inputs and outputs

Input

Parameter	Type	Required	Description
limit	string	No	Maximum number of results (default: 100, max: 2000)
fields	string	No	Comma-separated field API names (e.g., "Id,Name,Industry,Phone")
orderBy	string	No	Field and direction for sorting (e.g., "Name ASC" or "CreatedDate DESC")

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Accounts data
↳ paging	object	Pagination information from Salesforce API
↳ nextRecordsUrl	string	URL to fetch the next batch of records (present when done is false)
↳ totalSize	number	Total number of records matching the query (may exceed records returned)
↳ done	boolean	Whether all records have been returned (false if more batches exist)
↳ metadata	object	Response metadata
↳ totalReturned	number	Number of records returned in this response
↳ hasMore	boolean	Whether more records exist (inverse of done)
↳ accounts	array	Array of account objects
↳ success	boolean	Salesforce operation success

Create Account in Salesforce

Create a new account in Salesforce CRM

Inputs and outputs

Input

Parameter	Type	Required	Description
name	string	Yes	Account name (required)
type	string	No	Account type (e.g., Customer, Partner, Prospect)
industry	string	No	Industry (e.g., Technology, Healthcare, Finance)
phone	string	No	Phone number
website	string	No	Website URL
billingStreet	string	No	Billing street address
billingCity	string	No	Billing city
billingState	string	No	Billing state/province
billingPostalCode	string	No	Billing postal code
billingCountry	string	No	Billing country
description	string	No	Account description
annualRevenue	string	No	Annual revenue as a number
numberOfEmployees	string	No	Number of employees as an integer

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created account data
↳ id	string	The Salesforce ID of the newly created record
↳ success	boolean	Whether the create operation was successful
↳ created	boolean	Whether the record was created (always true on success)

Update Account in Salesforce

Update an existing account in Salesforce CRM

Inputs and outputs

Input

Parameter	Type	Required	Description
accountId	string	Yes	Salesforce Account ID to update (18-character string starting with 001)
name	string	No	Account name
type	string	No	Account type (e.g., Customer, Partner, Prospect)
industry	string	No	Industry (e.g., Technology, Healthcare, Finance)
phone	string	No	Phone number
website	string	No	Website URL
billingStreet	string	No	Billing street address
billingCity	string	No	Billing city
billingState	string	No	Billing state/province
billingPostalCode	string	No	Billing postal code
billingCountry	string	No	Billing country
description	string	No	Account description
annualRevenue	string	No	Annual revenue as a number
numberOfEmployees	string	No	Number of employees as an integer

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Updated account data
↳ id	string	The Salesforce ID of the updated record
↳ updated	boolean	Whether the record was updated (always true on success)

Delete Account from Salesforce

Delete an account from Salesforce CRM

Inputs and outputs

Input

Parameter	Type	Required	Description
accountId	string	Yes	Salesforce Account ID to delete (18-character string starting with 001)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Deleted account data
↳ id	string	The Salesforce ID of the deleted record
↳ deleted	boolean	Whether the record was deleted (always true on success)

Get Contacts from Salesforce

Get contact(s) from Salesforce - single contact if ID provided, or list if not

Inputs and outputs

Input

Parameter	Type	Required	Description
contactId	string	No	Salesforce Contact ID (18-character string starting with 003) to get a single contact
limit	string	No	Maximum number of results (default: 100, max: 2000). Only for list query.
fields	string	No	Comma-separated field API names (e.g., "Id,FirstName,LastName,Email,Phone")
orderBy	string	No	Field and direction for sorting (e.g., "LastName ASC"). Only for list query.

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Contact(s) data
↳ paging	object	Pagination information from Salesforce API
↳ nextRecordsUrl	string	URL to fetch the next batch of records (present when done is false)
↳ totalSize	number	Total number of records matching the query (may exceed records returned)
↳ done	boolean	Whether all records have been returned (false if more batches exist)
↳ metadata	object	Response metadata
↳ totalReturned	number	Number of records returned in this response
↳ hasMore	boolean	Whether more records exist (inverse of done)
↳ contacts	array	Array of contacts (list query)
↳ contact	object	Single contact (by ID)
↳ singleContact	boolean	Whether single contact was returned
↳ success	boolean	Salesforce operation success

Create Contact in Salesforce

Create a new contact in Salesforce CRM

Inputs and outputs

Input

Parameter	Type	Required	Description
lastName	string	Yes	Last name (required)
firstName	string	No	First name
email	string	No	Email address
phone	string	No	Phone number
accountId	string	No	Salesforce Account ID (18-character string starting with 001)
title	string	No	Job title
department	string	No	Department
mailingStreet	string	No	Mailing street
mailingCity	string	No	Mailing city
mailingState	string	No	Mailing state
mailingPostalCode	string	No	Mailing postal code
mailingCountry	string	No	Mailing country
description	string	No	Contact description

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created contact data
↳ id	string	The Salesforce ID of the newly created record
↳ success	boolean	Whether the create operation was successful
↳ created	boolean	Whether the record was created (always true on success)

Update Contact in Salesforce

Update an existing contact in Salesforce CRM

Inputs and outputs

Input

Parameter	Type	Required	Description
contactId	string	Yes	Salesforce Contact ID to update (18-character string starting with 003)
lastName	string	No	Last name
firstName	string	No	First name
email	string	No	Email address
phone	string	No	Phone number
accountId	string	No	Salesforce Account ID (18-character string starting with 001)
title	string	No	Job title
department	string	No	Department
mailingStreet	string	No	Mailing street
mailingCity	string	No	Mailing city
mailingState	string	No	Mailing state
mailingPostalCode	string	No	Mailing postal code
mailingCountry	string	No	Mailing country
description	string	No	Contact description

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Updated contact data
↳ id	string	The Salesforce ID of the updated record
↳ updated	boolean	Whether the record was updated (always true on success)

Delete Contact from Salesforce

Delete a contact from Salesforce CRM

Inputs and outputs

Input

Parameter	Type	Required	Description
contactId	string	Yes	Salesforce Contact ID to delete (18-character string starting with 003)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Deleted contact data
↳ id	string	The Salesforce ID of the deleted record
↳ deleted	boolean	Whether the record was deleted (always true on success)

Get Leads from Salesforce

Retrieve lead(s) from Salesforce CRM

Inputs and outputs

Input

Parameter	Type	Required	Description
leadId	string	No	Salesforce Lead ID (18-character string starting with 00Q) to get a single lead
limit	string	No	Maximum number of results to return (default: 100)
fields	string	No	Comma-separated list of field API names to return
orderBy	string	No	Field and direction for sorting (e.g., LastName ASC)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Lead data
↳ paging	object	Pagination information from Salesforce API
↳ nextRecordsUrl	string	URL to fetch the next batch of records (present when done is false)
↳ totalSize	number	Total number of records matching the query (may exceed records returned)
↳ done	boolean	Whether all records have been returned (false if more batches exist)
↳ metadata	object	Response metadata
↳ totalReturned	number	Number of records returned in this response
↳ hasMore	boolean	Whether more records exist (inverse of done)
↳ lead	object	Single lead object (when leadId provided)
↳ leads	array	Array of lead objects (when listing)
↳ singleLead	boolean	Whether single lead was returned
↳ success	boolean	Operation success status

Create Lead in Salesforce

Create a new lead

Inputs and outputs

Input

Parameter	Type	Required	Description
lastName	string	Yes	Last name (required)
company	string	Yes	Company name (required)
firstName	string	No	First name
email	string	No	Email address
phone	string	No	Phone number
status	string	No	Lead status (e.g., Open, Working, Closed)
leadSource	string	No	Lead source (e.g., Web, Referral, Campaign)
title	string	No	Job title
description	string	No	Lead description

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created lead data
↳ id	string	The Salesforce ID of the newly created record
↳ success	boolean	Whether the create operation was successful
↳ created	boolean	Whether the record was created (always true on success)

Update Lead in Salesforce

Update an existing lead

Inputs and outputs

Input

Parameter	Type	Required	Description
leadId	string	Yes	Salesforce Lead ID to update (18-character string starting with 00Q)
lastName	string	No	Last name
company	string	No	Company name
firstName	string	No	First name
email	string	No	Email address
phone	string	No	Phone number
status	string	No	Lead status (e.g., Open, Working, Closed)
leadSource	string	No	Lead source (e.g., Web, Referral, Campaign)
title	string	No	Job title
description	string	No	Lead description

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Updated lead data
↳ id	string	The Salesforce ID of the updated record
↳ updated	boolean	Whether the record was updated (always true on success)

Delete Lead from Salesforce

Delete a lead

Inputs and outputs

Input

Parameter	Type	Required	Description
leadId	string	Yes	Salesforce Lead ID to delete (18-character string starting with 00Q)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Deleted lead data
↳ id	string	The Salesforce ID of the deleted record
↳ deleted	boolean	Whether the record was deleted (always true on success)

Get Opportunities from Salesforce

Get opportunity(ies) from Salesforce

Inputs and outputs

Input

Parameter	Type	Required	Description
opportunityId	string	No	Salesforce Opportunity ID (18-character string starting with 006) to get a single opportunity
limit	string	No	Maximum number of results to return (default: 100)
fields	string	No	Comma-separated list of field API names to return
orderBy	string	No	Field and direction for sorting (e.g., CloseDate DESC)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Opportunity data
↳ paging	object	Pagination information from Salesforce API
↳ nextRecordsUrl	string	URL to fetch the next batch of records (present when done is false)
↳ totalSize	number	Total number of records matching the query (may exceed records returned)
↳ done	boolean	Whether all records have been returned (false if more batches exist)
↳ metadata	object	Response metadata
↳ totalReturned	number	Number of records returned in this response
↳ hasMore	boolean	Whether more records exist (inverse of done)
↳ opportunity	object	Single opportunity object (when opportunityId provided)
↳ opportunities	array	Array of opportunity objects (when listing)
↳ success	boolean	Operation success status

Create Opportunity in Salesforce

Create a new opportunity

Inputs and outputs

Input

Parameter	Type	Required	Description
name	string	Yes	Opportunity name (required)
stageName	string	Yes	Stage name (required, e.g., Prospecting, Qualification, Closed Won)
closeDate	string	Yes	Close date in YYYY-MM-DD format (required)
accountId	string	No	Salesforce Account ID (18-character string starting with 001)
amount	string	No	Deal amount as a number
probability	string	No	Win probability as integer (0-100)
description	string	No	Opportunity description

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created opportunity data
↳ id	string	The Salesforce ID of the newly created record
↳ success	boolean	Whether the create operation was successful
↳ created	boolean	Whether the record was created (always true on success)

Update Opportunity in Salesforce

Update an existing opportunity

Inputs and outputs

Input

Parameter	Type	Required	Description
opportunityId	string	Yes	Salesforce Opportunity ID to update (18-character string starting with 006)
name	string	No	Opportunity name
stageName	string	No	Stage name (e.g., Prospecting, Qualification, Closed Won)
closeDate	string	No	Close date in YYYY-MM-DD format
accountId	string	No	Salesforce Account ID (18-character string starting with 001)
amount	string	No	Deal amount as a number
probability	string	No	Win probability as integer (0-100)
description	string	No	Opportunity description

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Updated opportunity data
↳ id	string	The Salesforce ID of the updated record
↳ updated	boolean	Whether the record was updated (always true on success)

Delete Opportunity from Salesforce

Delete an opportunity

Inputs and outputs

Input

Parameter	Type	Required	Description
opportunityId	string	Yes	Salesforce Opportunity ID to delete (18-character string starting with 006)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Deleted opportunity data
↳ id	string	The Salesforce ID of the deleted record
↳ deleted	boolean	Whether the record was deleted (always true on success)

Get Cases from Salesforce

Get case(s) from Salesforce

Inputs and outputs

Input

Parameter	Type	Required	Description
caseId	string	No	Salesforce Case ID (18-character string starting with 500) to get a single case
limit	string	No	Maximum number of results to return (default: 100)
fields	string	No	Comma-separated list of field API names to return
orderBy	string	No	Field and direction for sorting (e.g., CreatedDate DESC)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Case data
↳ paging	object	Pagination information from Salesforce API
↳ nextRecordsUrl	string	URL to fetch the next batch of records (present when done is false)
↳ totalSize	number	Total number of records matching the query (may exceed records returned)
↳ done	boolean	Whether all records have been returned (false if more batches exist)
↳ metadata	object	Response metadata
↳ totalReturned	number	Number of records returned in this response
↳ hasMore	boolean	Whether more records exist (inverse of done)
↳ case	object	Single case object (when caseId provided)
↳ cases	array	Array of case objects (when listing)
↳ success	boolean	Operation success status

Create Case in Salesforce

Create a new case

Inputs and outputs

Input

Parameter	Type	Required	Description
subject	string	Yes	Case subject (required)
status	string	No	Status (e.g., New, Working, Escalated)
priority	string	No	Priority (e.g., Low, Medium, High)
origin	string	No	Origin (e.g., Phone, Email, Web)
contactId	string	No	Salesforce Contact ID (18-character string starting with 003)
accountId	string	No	Salesforce Account ID (18-character string starting with 001)
description	string	No	Case description

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created case data
↳ id	string	The Salesforce ID of the newly created record
↳ success	boolean	Whether the create operation was successful
↳ created	boolean	Whether the record was created (always true on success)

Update Case in Salesforce

Update an existing case

Inputs and outputs

Input

Parameter	Type	Required	Description
caseId	string	Yes	Salesforce Case ID to update (18-character string starting with 500)
subject	string	No	Case subject
status	string	No	Status (e.g., New, Working, Escalated, Closed)
priority	string	No	Priority (e.g., Low, Medium, High)
origin	string	No	Origin (e.g., Phone, Email, Web)
contactId	string	No	Salesforce Contact ID (18-character string starting with 003)
accountId	string	No	Salesforce Account ID (18-character string starting with 001)
description	string	No	Case description

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Updated case data
↳ id	string	The Salesforce ID of the updated record
↳ updated	boolean	Whether the record was updated (always true on success)

Delete Case from Salesforce

Delete a case

Inputs and outputs

Input

Parameter	Type	Required	Description
caseId	string	Yes	Salesforce Case ID to delete (18-character string starting with 500)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Deleted case data
↳ id	string	The Salesforce ID of the deleted record
↳ deleted	boolean	Whether the record was deleted (always true on success)

Get Tasks from Salesforce

Get task(s) from Salesforce

Inputs and outputs

Input

Parameter	Type	Required	Description
taskId	string	No	Salesforce Task ID (18-character string starting with 00T) to get a single task
limit	string	No	Maximum number of results to return (default: 100)
fields	string	No	Comma-separated list of field API names to return
orderBy	string	No	Field and direction for sorting (e.g., ActivityDate DESC)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Task data
↳ paging	object	Pagination information from Salesforce API
↳ nextRecordsUrl	string	URL to fetch the next batch of records (present when done is false)
↳ totalSize	number	Total number of records matching the query (may exceed records returned)
↳ done	boolean	Whether all records have been returned (false if more batches exist)
↳ metadata	object	Response metadata
↳ totalReturned	number	Number of records returned in this response
↳ hasMore	boolean	Whether more records exist (inverse of done)
↳ task	object	Single task object (when taskId provided)
↳ tasks	array	Array of task objects (when listing)
↳ success	boolean	Operation success status

Create Task in Salesforce

Create a new task

Inputs and outputs

Input

Parameter	Type	Required	Description
subject	string	Yes	Task subject (required)
status	string	No	Status (e.g., Not Started, In Progress, Completed)
priority	string	No	Priority (e.g., Low, Normal, High)
activityDate	string	No	Due date in YYYY-MM-DD format
whoId	string	No	Related Contact ID (003...) or Lead ID (00Q...)
whatId	string	No	Related Account ID (001...) or Opportunity ID (006...)
description	string	No	Task description

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created task data
↳ id	string	The Salesforce ID of the newly created record
↳ success	boolean	Whether the create operation was successful
↳ created	boolean	Whether the record was created (always true on success)

Update Task in Salesforce

Update an existing task

Inputs and outputs

Input

Parameter	Type	Required	Description
taskId	string	Yes	Salesforce Task ID to update (18-character string starting with 00T)
subject	string	No	Task subject
status	string	No	Status (e.g., Not Started, In Progress, Completed)
priority	string	No	Priority (e.g., Low, Normal, High)
activityDate	string	No	Due date in YYYY-MM-DD format
whoId	string	No	Related Contact ID (003...) or Lead ID (00Q...)
whatId	string	No	Related Account ID (001...) or Opportunity ID (006...)
description	string	No	Task description

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Updated task data
↳ id	string	The Salesforce ID of the updated record
↳ updated	boolean	Whether the record was updated (always true on success)

Delete Task from Salesforce

Delete a task

Inputs and outputs

Input

Parameter	Type	Required	Description
taskId	string	Yes	Salesforce Task ID to delete (18-character string starting with 00T)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Deleted task data
↳ id	string	The Salesforce ID of the deleted record
↳ deleted	boolean	Whether the record was deleted (always true on success)

List Reports from Salesforce

Get a list of up to 200 recently viewed reports for the current user

Inputs and outputs

Input

Parameter	Type	Required	Description
searchTerm	string	No	Filter reports by name (case-insensitive partial match)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Reports data
↳ reports	array	Array of report objects
↳ totalReturned	number	Number of items returned
↳ success	boolean	Salesforce operation success

Get Report Metadata from Salesforce

Get the describe (definition and metadata) for a specific report

Inputs and outputs

Input

Parameter	Type	Required	Description
reportId	string	Yes	Salesforce Report ID (18-character string starting with 00O)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Report metadata
↳ report	object	Report metadata object
↳ reportId	string	Report ID
↳ success	boolean	Salesforce operation success

Run Report in Salesforce

Execute a report and retrieve the results

Inputs and outputs

Input

Parameter	Type	Required	Description
reportId	string	Yes	Salesforce Report ID (18-character string starting with 00O)
includeDetails	string	No	Include detail rows (true/false, default: true)
filters	string	No	JSON array of report filter objects to apply

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Report results
↳ reportId	string	Report ID
↳ reportMetadata	object	Report metadata including name, format, and filter definitions
↳ reportExtendedMetadata	object	Extended metadata for aggregate columns and groupings
↳ factMap	object	Report data organized by groupings with aggregates and row data
↳ groupingsDown	object	Row grouping hierarchy and values
↳ groupingsAcross	object	Column grouping hierarchy and values
↳ hasDetailRows	boolean	Whether the report includes detail-level row data
↳ allData	boolean	Whether all data is returned (false if truncated due to size limits)
↳ reportName	string	Display name of the report
↳ reportFormat	string	Report format type (TABULAR, SUMMARY, MATRIX, JOINED)
↳ success	boolean	Salesforce operation success

List Report Types from Salesforce

Get a list of available report types

Inputs and outputs

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Report types data
↳ reportTypes	array	Array of report type objects
↳ totalReturned	number	Number of items returned
↳ success	boolean	Salesforce operation success

List Dashboards from Salesforce

Get a list of recently used dashboards for the current user

Inputs and outputs

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Dashboards data
↳ dashboards	array	Array of dashboard objects
↳ totalReturned	number	Number of items returned
↳ success	boolean	Salesforce operation success

Get Dashboard from Salesforce

Get details and results for a specific dashboard

Inputs and outputs

Input

Parameter	Type	Required	Description
dashboardId	string	Yes	Salesforce Dashboard ID (18-character string starting with 01Z)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Dashboard data
↳ dashboard	object	Full dashboard details object
↳ dashboardId	string	Dashboard ID
↳ components	array	Array of dashboard component data with visualizations and filters
↳ dashboardName	string	Display name of the dashboard
↳ dashboardMetadata	object	Structured dashboard metadata (attributes, component definitions, layout)
↳ runningUser	object	User context under which the dashboard data was retrieved
↳ success	boolean	Salesforce operation success

Refresh Dashboard in Salesforce

Refresh a dashboard to get the latest data

Inputs and outputs

Input

Parameter	Type	Required	Description
dashboardId	string	Yes	Salesforce Dashboard ID (18-character string starting with 01Z)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Refreshed dashboard data
↳ dashboard	object	Full dashboard details object
↳ dashboardId	string	Dashboard ID
↳ components	array	Array of dashboard component data with fresh visualizations
↳ status	object	Dashboard refresh status (dashboardStatus), when returned by the refresh
↳ statusUrl	string	URL of the status resource to poll for refresh completion
↳ dashboardName	string	Display name of the dashboard
↳ dashboardMetadata	object	Structured dashboard metadata (attributes, component definitions, layout)
↳ success	boolean	Salesforce operation success

Run SOQL Query in Salesforce

Execute a custom SOQL query to retrieve data from Salesforce

Inputs and outputs

Input

Parameter	Type	Required	Description
query	string	Yes	SOQL query to execute (e.g., SELECT Id, Name FROM Account LIMIT 10)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Query results
↳ records	array	Array of sObject records matching the query
↳ query	string	The executed SOQL query
↳ metadata	object	Response metadata
↳ totalReturned	number	Number of records returned in this response
↳ hasMore	boolean	Whether more records exist (inverse of done)
↳ success	boolean	Salesforce operation success

Get More Query Results from Salesforce

Retrieve additional query results using the nextRecordsUrl from a previous query

Inputs and outputs

Input

Parameter	Type	Required	Description
nextRecordsUrl	string	Yes	The nextRecordsUrl value from a previous query response (e.g., /services/data/v59.0/query/01g...)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Query results
↳ records	array	Array of sObject records matching the query
↳ metadata	object	Response metadata
↳ totalReturned	number	Number of records returned in this response
↳ hasMore	boolean	Whether more records exist (inverse of done)
↳ success	boolean	Salesforce operation success

Describe Salesforce Object

Get metadata and field information for a Salesforce object

Inputs and outputs

Input

Parameter	Type	Required	Description
objectName	string	Yes	Salesforce object API name (e.g., Account, Contact, Lead, Custom_Object__c)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Object metadata
↳ objectName	string	API name of the object (e.g., Account, Contact)
↳ label	string	Human-readable singular label for the object
↳ labelPlural	string	Human-readable plural label for the object
↳ fields	array	Array of field metadata objects
↳ name	string	API name of the field
↳ label	string	Display label of the field
↳ type	string	Field data type (string, boolean, int, double, date, etc.)
↳ length	number	Maximum length for text fields
↳ precision	number	Precision for numeric fields
↳ scale	number	Scale for numeric fields
↳ nillable	boolean	Whether the field can be null
↳ unique	boolean	Whether values must be unique
↳ createable	boolean	Whether field can be set on create
↳ updateable	boolean	Whether field can be updated
↳ defaultedOnCreate	boolean	Whether field has default value on create
↳ calculated	boolean	Whether field is a formula field
↳ autoNumber	boolean	Whether field is auto-number
↳ externalId	boolean	Whether field is an external ID
↳ idLookup	boolean	Whether field can be used in ID lookup
↳ inlineHelpText	string	Help text for the field
↳ picklistValues	array	Available picklist values for picklist fields
↳ referenceTo	array	Objects this field can reference (for lookup fields)
↳ relationshipName	string	Relationship name for lookup fields
↳ custom	boolean	Whether this is a custom field
↳ filterable	boolean	Whether field can be used in SOQL filter
↳ groupable	boolean	Whether field can be used in GROUP BY
↳ sortable	boolean	Whether field can be used in ORDER BY
↳ keyPrefix	string	Three-character prefix used in record IDs (e.g., "001" for Account)
↳ queryable	boolean	Whether the object can be queried via SOQL
↳ createable	boolean	Whether records can be created for this object
↳ updateable	boolean	Whether records can be updated for this object
↳ deletable	boolean	Whether records can be deleted for this object
↳ childRelationships	array	Array of child relationship metadata for related objects
↳ recordTypeInfos	array	Array of record type information for the object
↳ fieldCount	number	Total number of fields on the object
↳ success	boolean	Salesforce operation success

List Salesforce Objects

Get a list of all available Salesforce objects

Inputs and outputs

Input

Parameter	Type	Required	Description

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Objects list
↳ objects	array	Array of sObject metadata
↳ name	string	API name of the object
↳ label	string	Display label of the object
↳ labelPlural	string	Plural display label
↳ keyPrefix	string	Three-character ID prefix
↳ custom	boolean	Whether this is a custom object
↳ queryable	boolean	Whether object can be queried
↳ createable	boolean	Whether records can be created
↳ updateable	boolean	Whether records can be updated
↳ deletable	boolean	Whether records can be deleted
↳ searchable	boolean	Whether object is searchable
↳ triggerable	boolean	Whether triggers are supported
↳ layoutable	boolean	Whether page layouts are supported
↳ replicateable	boolean	Whether object can be replicated
↳ retrieveable	boolean	Whether records can be retrieved
↳ undeletable	boolean	Whether records can be undeleted
↳ urls	object	URLs for accessing object resources
↳ encoding	string	Character encoding for the organization (e.g., UTF-8)
↳ maxBatchSize	number	Maximum number of records that can be returned in a single query batch (typically 200)
↳ totalReturned	number	Number of objects returned
↳ success	boolean	Salesforce operation success

Create Custom Field in Salesforce

Create a custom field on a Salesforce object (e.g., Account) using the Tooling API

Inputs and outputs

Input

Parameter	Type	Required	Description
objectName	string	Yes	API name of the object to add the field to (e.g., Account, Contact, Lead, MyObject__c)
fieldName	string	Yes	API name of the new field; the __c suffix is added automatically (e.g., Region)
label	string	No	Display label shown in the UI (defaults to the field name when omitted)
fieldType	string	Yes	Field data type: Text, TextArea, LongTextArea, Html, Number, Currency, Percent, Checkbox, Date, DateTime, Time, Phone, Email, Url, Picklist, or MultiselectPicklist
length	number	No	Maximum length for Text (1-255), LongTextArea, Html, or MultiselectPicklist fields
precision	number	No	Total number of digits for Number, Currency, or Percent fields (1-18)
scale	number	No	Number of digits to the right of the decimal for numeric fields
visibleLines	number	No	Number of visible lines for LongTextArea, Html, or MultiselectPicklist fields
required	boolean	No	Whether the field is required on record create/edit
unique	boolean	No	Whether the field enforces unique values
externalId	boolean	No	Whether the field is an external ID (for Text, Number, or Email fields)
defaultValue	string	No	Default value; for Checkbox fields use true or false
description	string	No	Internal description of the field
inlineHelpText	string	No	Help text shown next to the field in the UI
picklistValues	string	No	Comma-separated values for Picklist or MultiselectPicklist fields

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created custom field metadata
↳ id	string	Tooling API Id of the newly created custom field
↳ fullName	string	Full API name of the field, including object (e.g., Account.Region__c)
↳ success	boolean	Whether the create operation was successful
↳ created	boolean	Whether the field was created (always true on success)

Update Custom Field in Salesforce

Update an existing custom field on a Salesforce object using the Tooling API

Inputs and outputs

Input

Parameter	Type	Required	Description
fieldId	string	Yes	Tooling API Id of the custom field to update (find it via the Tooling Query tool)
label	string	No	Display label shown in the UI
length	number	No	Maximum length for Text, LongTextArea, Html, or MultiselectPicklist fields
precision	number	No	Total number of digits for Number, Currency, or Percent fields
scale	number	No	Number of digits to the right of the decimal for numeric fields
visibleLines	number	No	Number of visible lines for LongTextArea, Html, or MultiselectPicklist fields
required	boolean	No	Whether the field is required on record create/edit
unique	boolean	No	Whether the field enforces unique values
externalId	boolean	No	Whether the field is an external ID
defaultValue	string	No	Default value; for Checkbox fields use true or false
description	string	No	Internal description of the field
inlineHelpText	string	No	Help text shown next to the field in the UI
picklistValues	string	No	Comma-separated values to add to a Picklist or MultiselectPicklist field (existing values are kept)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Updated custom field metadata
↳ id	string	Tooling API Id of the updated custom field
↳ updated	boolean	Whether the field was updated (always true on success)

Delete Custom Field in Salesforce

Delete a custom field from a Salesforce object using the Tooling API

Inputs and outputs

Input

Parameter	Type	Required	Description
fieldId	string	Yes	Tooling API Id of the custom field to delete (find it via the Tooling Query tool)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Deleted custom field metadata
↳ id	string	Tooling API Id of the deleted custom field
↳ deleted	boolean	Whether the field was deleted (always true on success)

Create Custom Object in Salesforce

Create a custom object in Salesforce using the Tooling API

Inputs and outputs

Input

Parameter	Type	Required	Description
objectName	string	Yes	API name of the new object; the __c suffix is added automatically (e.g., Project)
label	string	Yes	Singular display label for the object (e.g., Project)
pluralLabel	string	Yes	Plural display label for the object (e.g., Projects)
nameFieldLabel	string	No	Label for the standard Name field (defaults to "<label> Name")
description	string	No	Internal description of the object
sharingModel	string	No	Org-wide sharing model: ReadWrite, Read, Private, or ControlledByParent (default ReadWrite)

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Created custom object metadata
↳ id	string	Tooling API Id of the newly created custom object
↳ fullName	string	Full API name of the object (e.g., Project__c)
↳ success	boolean	Whether the create operation was successful
↳ created	boolean	Whether the object was created (always true on success)

Run Tooling SOQL Query in Salesforce

Execute a SOQL query against the Tooling API to inspect metadata objects

Inputs and outputs

Input

Parameter	Type	Required	Description
query	string	Yes	Tooling SOQL query (e.g., SELECT Id, DeveloperName FROM CustomField WHERE TableEnumOrId = 'Account')

Output

Parameter	Type	Description
success	boolean	Operation success status
output	object	Tooling query results
↳ records	array	Array of Tooling API records matching the query
↳ query	string	The executed Tooling SOQL query
↳ metadata	object	Response metadata
↳ totalReturned	number	Number of records returned in this response
↳ hasMore	boolean	Whether more records exist (inverse of done)
↳ success	boolean	Salesforce operation success

Triggers

A trigger starts a workflow when a supported event occurs in this service.

Salesforce Case Status Changed

Trigger workflow when a case status changes

Configuration

Output

---

Salesforce Opportunity Stage Changed

Trigger workflow when an opportunity stage changes

Configuration

Output

---

Salesforce Record Created

Trigger workflow when a Salesforce record is created

Configuration

Output

---

Salesforce Record Deleted

Trigger workflow when a Salesforce record is deleted

Configuration

Output

---

Salesforce Record Updated

Trigger workflow when a Salesforce record is updated

Configuration

Output

---

Salesforce Webhook (All Events)

Trigger workflow on any Salesforce webhook event

Configuration

Output