← Back to all apps

Salesforce

by OpenAI

Interact with Salesforce CRM data.

12ChatGPT Tools
OpenAIDeveloper

Available Tools

Call Apex Rest Endpoint

call_apex_rest_endpoint
Full Description

Invoke a Salesforce Apex REST endpoint implemented by the connected org.

Parameters (2 required, 2 optional)
Required
methodstring

HTTP method to use when calling the Apex REST endpoint.

Options:GETPOSTPUTPATCHDELETE
pathstring

REST path under `/services/apexrest`, such as `v1/action/123`.

Optional
json_bodyobject

Optional JSON object payload for POST, PUT, or PATCH requests.

Default: null
query_paramsobject

Optional query parameters to send with the Apex REST request.

Default: null

Create Sobject Record

create_sobject_record
Full Description

Create a Salesforce sObject record.

Parameters (2 required, 2 optional)
Required
fieldsobject

Map of Salesforce field API names to values for the new record.

object_api_namestring

Target Salesforce object API name.

Optional
record_type_idstring

Optional record type ID to set as RecordTypeId.

Default: null
return_fieldsarray

Optional field API names to re-read after creation.

Default: null

Delete Sobject Record

delete_sobject_record
Full Description

Delete a Salesforce sObject record.

Parameters (2 required)
Required
object_api_namestring

Required sObject API name used in the REST resource path.

record_idstring

Salesforce record ID to delete.

Describe Account

describe_account
Full Description

Retrieve the Salesforce Account object metadata using the sObject Describe resource. Returns: DescribeSObjectResult: The parsed Salesforce API response describing the Account object.

Describe Contact

describe_contact
Full Description

Retrieve the Salesforce Contact object metadata using the sObject Describe resource. See: https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_sobject_describe.htm Returns: DescribeSObjectResult: The parsed Salesforce API response describing the Contact object.

Describe Global

describe_global
Full Description

List Salesforce sObjects available to the authenticated user.

Parameters (0 required, 1 optional)
Optional
api_versionstring

Optional Salesforce REST API version string, such as `v61.0`.

Default: null

Describe Lead

describe_lead
Full Description

Retrieve the Salesforce Lead object metadata using the sObject Describe resource. Returns: DescribeSObjectResult: The parsed Salesforce API response describing the Lead object.

Describe Opportunity

describe_opportunity
Full Description

Retrieve the Salesforce Opportunity object metadata using the sObject Describe resource. Returns: DescribeSObjectResult: The parsed Salesforce API response describing the Opportunity object.

Describe Sobject

describe_sobject
Full Description

Retrieve Salesforce metadata for an sObject.

Parameters (2 required, 3 optional)
Required
object_api_namestring

Exact Salesforce object API name, such as `Account` or `Project__c`.

sobjectstring
Optional
api_versionstring

Optional Salesforce API version string such as `v61.0`.

Default: null
metadata_modestring

Provider metadata surface to prefer.

Options:describebasicobject_info
Default: describe
record_type_idstring

Optional record type ID for object-info metadata.

Default: null

Get Account

get_account
Full Description

Retrieve a Salesforce account by ID. Args: account_id: The Salesforce Account ID (e.g., '001...'). Returns: Account: A minimal Account Pydantic model with core fields and the unmapped fields in 'other_fields'.

Parameters (1 required)
Required
account_idstring

Get Contact

get_contact
Full Description

Retrieve a Salesforce contact by ID. Args: contact_id: The Salesforce Contact ID (e.g., '003...'). Returns: Contact: A minimal Contact Pydantic model with core fields and the unmapped fields in 'other_fields'.

Parameters (1 required)
Required
contact_idstring

Get Current User

get_current_user
Full Description

Retrieve the authenticated Salesforce user.

Parameters (0 required, 2 optional)
Optional
fieldsarray

Optional User fields to request, such as Id, Name, or Email.

Default: null
query_modestring

Provider surface for retrieving the current user.

Options:graphql_current_useruser_record
Default: graphql_current_user

Get Lead

get_lead
Full Description

Retrieve a Salesforce lead by ID. Args: lead_id: The Salesforce Lead ID (e.g., '00Q...'). Returns: Lead: A minimal Lead Pydantic model with core fields and the unmapped fields in 'other_fields'.

Parameters (1 required)
Required
lead_idstring

Get Opportunity

get_opportunity
Full Description

Retrieve a Salesforce opportunity by ID. Args: opportunity_id: The Salesforce Opportunity ID (e.g., '006...'). Returns: Opportunity: A minimal Opportunity Pydantic model with core fields and the unmapped fields in 'other_fields'.

Parameters (1 required)
Required
opportunity_idstring

Get Profile

get_profile
Full Description

Return the authenticated user's Salesforce profile.

Get Sobject

get_sobject
Full Description

Retrieve a Salesforce sObject record by ID. Args: sobject: The Salesforce sObject name (e.g., 'Contact', 'Account', 'CustomObject__c'). record_id: The Salesforce record ID. Returns: dict: The full API response for the record.

Parameters (2 required)
Required
record_idstring
sobjectstring

Get Sobject Record

get_sobject_record
Full Description

Retrieve a Salesforce sObject record by ID.

Parameters (2 required, 1 optional)
Required
object_api_namestring

Required sObject API name used in the REST resource path.

record_idstring

Salesforce record ID to retrieve.

Optional
fieldsarray

Optional explicit field projections for the retrieve request.

Default: null

List Sobjects

list_sobjects
Full Description

Retrieve the Salesforce sObjects available to the authenticated user. Returns: ListSObjectsResponse: The list of accessible objects and their metadata.

Query More

query_more
Full Description

Retrieve the next provider-sized page for a Salesforce query.

Parameters (1 required, 1 optional)
Required
query_locatorstring

Opaque Salesforce query locator token returned by a prior query response.

Optional
batch_sizeinteger

Optional Salesforce page-size hint, not a hard result limit.

Default: null

Query Soql

query_soql
Full Description

Run a Salesforce SOQL query.

Parameters (1 required, 1 optional)
Required
soqlstring

Raw Salesforce SOQL query string. Use SOSL via search_sosl for full-text search.

Optional
batch_sizeinteger

Optional Salesforce page-size hint, not a hard result limit.

Default: null

Search Sosl

search_sosl
Full Description

Run a Salesforce SOSL search.

Parameters (1 required, 2 optional)
Required
soslstring

Raw Salesforce SOSL search string, such as `FIND {Acme} RETURNING Account(Id)`.

Optional
batch_sizeinteger

Optional Salesforce page-size hint, not a hard result limit.

Default: null
returning_layoutboolean

Whether the implementation should attempt to attach search layout metadata.

Default: False

Update Sobject Record

update_sobject_record
Full Description

Update a Salesforce sObject record.

Parameters (3 required, 2 optional)
Required
fieldsobject

Map of Salesforce field API names to values to update.

object_api_namestring

Required sObject API name used in the REST resource path.

record_idstring

Salesforce record ID to update.

Optional
if_unmodified_sincestring

Optional optimistic concurrency timestamp header value.

Default: null
return_fieldsarray

Optional field API names to re-read after update.

Default: null

Upsert Sobject Record By External Id

upsert_sobject_record_by_external_id
Full Description

Upsert a Salesforce sObject record by external ID.

Parameters (4 required, 1 optional)
Required
external_id_fieldstring

API name of the field Salesforce should use for external-ID matching.

external_id_valuestring

External ID value to match.

fieldsobject

Map of Salesforce field API names to values to upsert.

object_api_namestring

Target object API name.

Optional
return_fieldsarray

Optional field API names to re-read after the upsert.

Default: null