developer.salesforce.com

•

One-click Login

About Salesforce Rest Api

The Salesforce REST API provides programmatic access to Salesforce data using standard HTTP methods. It supports creating, reading, updating, and deleting records for any object (leads, contacts, opportunities, cases, custom objects), running SOQL queries, and managing metadata. It is the primary integration surface for connecting external apps and automation workflows to Salesforce CRM. API call limits are allocated per-org based on edition and user count rather than billed separately.

AI Agent Use Cases

- Full CRUD operations on all standard and custom Salesforce objects

- SOQL query execution via /query endpoint

- Bulk API support for processing large datasets

- Metadata API for reading and deploying configuration

- OAuth 2.0 authentication with named credentials support

- API call limits allocated per org (edition + user count based, not separately charged)

Available Actions

These are the specific actions that AI agents can perform with this tool

Add Contact to Campaign

2 inputs

Associates an existing contact with an existing Salesforce campaign by creating a campaign member record.

Inputs

campaignId

The Campaign to add a Contact to.

contactId

The Contact to add to the selected Campaign.

Add Lead to Campaign

2 inputs

Associates an existing lead with a specified campaign in Salesforce to track campaign engagement.

Inputs

campaignId

The Campaign to add a Lead to.

leadId

The Lead to add to the selected Campaign.

Convert SOAP XML Object to JSON

4 inputs

Transforms a Salesforce SOAP XML response into a structured JSON format for easier data manipulation.

Inputs

infoBox

xml

The object received from Salesforce that will be converted.

extractNotificationOnly

Whether to extract only the notification parts from the XML. Default: `true`.

failOnError

Whether the action should fail if an error occurs when extracting notifications. Default: `false`.

Create Account

Creates a new account record in Salesforce with specified details.

Create Attachment

Creates a new Attachment record linked to a specified parent Salesforce object.

Create Campaign

Creates a new marketing campaign in Salesforce with specified campaign details.

Create Case

Creates a new Case record in Salesforce to log and track a customer issue or problem.

Create Case Comment

Creates a new comment on a specified Salesforce Case to capture additional details or updates.

Create Contact

Creates a new contact record in Salesforce with the provided contact details

Create Content Note

Creates a new content note in Salesforce to store rich text or files associated with records.

Create Event

Creates a new event record in Salesforce with specified details

Create Lead

Creates a new lead record in Salesforce with specified attributes to capture potential customer information.

Create Note

Creates a new note in Salesforce associated with a specified record.

Create Opportunity

Creates a new sales opportunity in Salesforce with specified details

Create Record

1 input

Creates a new record for a specified Salesforce object using the REST API.

Inputs

objectType

The type of object to create a record of

Create Task

Creates a new task record in Salesforce with specified details

Create User

Creates a new user in Salesforce by submitting the required user details via the REST API.

Delete Opportunity

1 input

Deletes a specified opportunity record from Salesforce using the REST API.

Inputs

recordId

ID of the opportunity to delete.

Delete Record

2 inputs

Deletes a specified record from a Salesforce object using its unique record ID.

Inputs

sobjectType

The type of object to delete a record of.

recordId

The record to delete.

Find Records

3 inputs

Retrieves specified fields from one or more records of a chosen Salesforce object.

Inputs

sobjectType

The type of object to obtain records of.

fieldsToObtain

Select the field(s) to obtain for the selected record(s) (or all records).

recordIds

The record(s) to retrieve. If not specified, all records will be retrieved.

Insert Blob Data

7 inputs

Inserts binary large object (blob) data into standard Salesforce objects via the REST API

Inputs

entiyName

Name of the entity to insert as part of the form-data sent along the Salesforce API as a request with multipart/form-data content type. I.e. entityDocument for Documents.

entityDocument

Salesforce object entity to insert.

formContentName

Name of the binary content to insert as part of the form-data sent along the Salesforce API as a request with multipart/form-data content type.

filename

Filename of the blob data to insert.

contentType

Mime type of the content to insert.

attachmentBinarycontent

Binary content of the blob data to insert.

sobjectName

Salesforce standard object type to insert.

Post a Message to Chatter Feed

3 inputs

Creates and posts a new feed item to a specified Chatter feed within Salesforce.

Inputs

sobjectType

The type of object to select a record from.

subjectId

The record that will parent the feed item.

messageSegments

Each message segment can be a text string, which will be treated as a segment of `type: Text`, or a [message segment object](https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_requests_message_body_input.htm) such as `{ \

SOQL Query (Object Query)

2 inputs

Executes a SOQL query to retrieve Salesforce records matching specified criteria.

Inputs

exampleInfo

query

SOQL Query

SOSL Search (Object Search)

2 inputs

Performs a text-based search across multiple Salesforce objects using SOSL to retrieve relevant records matching the search criteria.

Inputs

exampleInfo

SOSL Query

Search Object Records

4 inputs

Performs a parameterized search query to find records across Salesforce objects based on specified search criteria.

Inputs

infoBox

sobjectType

The type of object to search for records.

searchTerm

The term to search for.

fields

List of the Salesforce object

Update Account

1 input

Updates the specified Account record in Salesforce with new data provided.

Inputs

accountId

The Account to update.

Update Contact

1 input

Updates an existing Contact record in Salesforce with specified field values.

Inputs

contactId

The Contact to update.

Update Opportunity

1 input

Updates the details of an existing Opportunity record in Salesforce using the REST API.

Inputs

opportunityId

The Opportunity to update.

Update Record

3 inputs

Updates specified fields of a Salesforce record identified by its object type and record ID.

Inputs

sobjectType

The type of object to update a record of.

recordId

The record to update.

fieldsToUpdate

Select the field(s) you want to update for this record.

Upsert Record

1 input

Creates a new record or updates an existing record for a specified Salesforce object using an external ID.

Inputs

objectType

The type of object to create a record of

About Salesforce Rest Api

AI Agent Use Cases

- Full CRUD operations on all standard and custom Salesforce objects

- SOQL query execution via /query endpoint

- Bulk API support for processing large datasets

- Metadata API for reading and deploying configuration

- OAuth 2.0 authentication with named credentials support

- API call limits allocated per org (edition + user count based, not separately charged)

Available Actions

These are the specific actions that AI agents can perform with this tool

Add Contact to Campaign

2 inputs

Associates an existing contact with an existing Salesforce campaign by creating a campaign member record.

Inputs

campaignId

The Campaign to add a Contact to.

contactId

The Contact to add to the selected Campaign.

Add Lead to Campaign

2 inputs

Associates an existing lead with a specified campaign in Salesforce to track campaign engagement.

Inputs

campaignId

The Campaign to add a Lead to.

leadId

The Lead to add to the selected Campaign.

Convert SOAP XML Object to JSON

4 inputs

Transforms a Salesforce SOAP XML response into a structured JSON format for easier data manipulation.

Inputs

infoBox

xml

The object received from Salesforce that will be converted.

extractNotificationOnly

Whether to extract only the notification parts from the XML. Default: `true`.

failOnError

Whether the action should fail if an error occurs when extracting notifications. Default: `false`.

Create Account

Creates a new account record in Salesforce with specified details.

Create Attachment

Creates a new Attachment record linked to a specified parent Salesforce object.

Create Campaign

Creates a new marketing campaign in Salesforce with specified campaign details.

Create Case

Creates a new Case record in Salesforce to log and track a customer issue or problem.

Create Case Comment

Creates a new comment on a specified Salesforce Case to capture additional details or updates.

Create Contact

Creates a new contact record in Salesforce with the provided contact details

Create Content Note

Creates a new content note in Salesforce to store rich text or files associated with records.

Create Event

Creates a new event record in Salesforce with specified details

Create Lead

Creates a new lead record in Salesforce with specified attributes to capture potential customer information.

Create Note

Creates a new note in Salesforce associated with a specified record.

Create Opportunity

Creates a new sales opportunity in Salesforce with specified details

Create Record

1 input

Creates a new record for a specified Salesforce object using the REST API.

Inputs

objectType

The type of object to create a record of

Create Task

Creates a new task record in Salesforce with specified details

Create User

Creates a new user in Salesforce by submitting the required user details via the REST API.

Delete Opportunity

1 input

Deletes a specified opportunity record from Salesforce using the REST API.

Inputs

recordId

ID of the opportunity to delete.

Delete Record

2 inputs

Deletes a specified record from a Salesforce object using its unique record ID.

Inputs

sobjectType

The type of object to delete a record of.

recordId

The record to delete.

Find Records

3 inputs

Retrieves specified fields from one or more records of a chosen Salesforce object.

Inputs

sobjectType

The type of object to obtain records of.

fieldsToObtain

Select the field(s) to obtain for the selected record(s) (or all records).

recordIds

The record(s) to retrieve. If not specified, all records will be retrieved.

Insert Blob Data

7 inputs

Inserts binary large object (blob) data into standard Salesforce objects via the REST API

Inputs

entiyName

Name of the entity to insert as part of the form-data sent along the Salesforce API as a request with multipart/form-data content type. I.e. entityDocument for Documents.

entityDocument

Salesforce object entity to insert.

formContentName

Name of the binary content to insert as part of the form-data sent along the Salesforce API as a request with multipart/form-data content type.

filename

Filename of the blob data to insert.

contentType

Mime type of the content to insert.

attachmentBinarycontent

Binary content of the blob data to insert.

sobjectName

Salesforce standard object type to insert.

Post a Message to Chatter Feed

3 inputs

Creates and posts a new feed item to a specified Chatter feed within Salesforce.

Inputs

sobjectType

The type of object to select a record from.

subjectId

The record that will parent the feed item.

messageSegments

SOQL Query (Object Query)

2 inputs

Executes a SOQL query to retrieve Salesforce records matching specified criteria.

Inputs

exampleInfo

query

SOQL Query

SOSL Search (Object Search)

2 inputs

Performs a text-based search across multiple Salesforce objects using SOSL to retrieve relevant records matching the search criteria.

Inputs

exampleInfo

SOSL Query

Search Object Records

4 inputs

Performs a parameterized search query to find records across Salesforce objects based on specified search criteria.

Inputs

infoBox

sobjectType

The type of object to search for records.

searchTerm

The term to search for.

fields

List of the Salesforce object

Update Account

1 input

Updates the specified Account record in Salesforce with new data provided.

Inputs

accountId

The Account to update.

Update Contact

1 input

Updates an existing Contact record in Salesforce with specified field values.

Inputs

contactId

The Contact to update.

Update Opportunity

1 input

Updates the details of an existing Opportunity record in Salesforce using the REST API.

Inputs

opportunityId

The Opportunity to update.

Update Record

3 inputs

Updates specified fields of a Salesforce record identified by its object type and record ID.

Inputs

sobjectType

The type of object to update a record of.

recordId

The record to update.

fieldsToUpdate

Select the field(s) you want to update for this record.

Upsert Record

1 input

Creates a new record or updates an existing record for a specified Salesforce object using an external ID.

Inputs

objectType

The type of object to create a record of