Salesforce | Composio Docs

Overview

SLUG

SALESFORCE

Description

Salesforce is a leading CRM platform integrating sales, service, marketing, and analytics to build customer relationships and drive business growth

Authentication Details

OAuth2

client_id

stringRequired

client_secret

stringRequired

oauth_redirect_uri

stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add

scopes

stringDefaults to full,refresh_token

bearer_token

string

suffix_one

stringDefaults to /services/data/v61.0Required

Tools

Create Salesforce Account

SLUG: SALESFORCE_ACCOUNT_CREATION_WITH_CONTENT_TYPE_OPTION

Creates a new salesforce account using a json post request, requiring 'name'; specific fields (e.g., custom, dunsnumber) may have org-level prerequisites.

Action Parameters

AccountNumber

string

AccountSource

string

Active__c

string

AnnualRevenue

integer

BillingCity

string

BillingCountry

string

BillingGeocodeAccuracy

string

BillingLatitude

integer

BillingLongitude

integer

BillingPostalCode

string

BillingState

string

BillingStreet

string

CleanStatus

string

CreatedById

string

CreatedDate

string

CustomerPriority__c

string

DandbCompanyId

string

Description

string

DunsNumber

string

Fax

string

Industry

string

IsDeleted

boolean

Jigsaw

string

JigsawCompanyId

string

LastActivityDate

string

LastModifiedById

string

LastModifiedDate

string

LastReferencedDate

string

LastViewedDate

string

MasterRecordId

string

NaicsCode

string

NaicsDesc

string

Name

string

NumberOfEmployees

integer

NumberofLocations__c

integer

OperatingHoursId

string

OwnerId

string

Ownership

string

ParentId

string

Phone

string

PhotoUrl

string

Rating

string

SLAExpirationDate__c

string

SLASerialNumber__c

string

SLA__c

string

ShippingCity

string

ShippingCountry

string

ShippingGeocodeAccuracy

string

ShippingLatitude

integer

ShippingLongitude

integer

ShippingPostalCode

string

ShippingState

string

ShippingStreet

string

Sic

string

SicDesc

string

Site

string

SystemModstamp

string

TickerSymbol

string

Tradestyle

string

Type

string

UpsellOpportunity__c

string

Website

string

YearStarted

string

attributes__type

string

attributes__url

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create campaign record

SLUG: SALESFORCE_CREATE_CAMPAIGN_RECORD_VIA_POST

Creates a new campaign record in salesforce; if 'parentid' is provided, it must be a valid id of an existing campaign record, and if 'ownerid' is provided, it must be a valid id of an active user.

Action Parameters

ActualCost

integer

AmountAllOpportunities

integer

AmountWonOpportunities

integer

BudgetedCost

integer

CampaignMemberRecordTypeId

string

CreatedById

string

CreatedDate

string

Description

string

EndDate

string

ExpectedResponse

integer

ExpectedRevenue

integer

string

IsActive

boolean

IsDeleted

boolean

LastActivityDate

string

LastModifiedById

string

LastModifiedDate

string

LastReferencedDate

string

LastViewedDate

string

Name

string

NumberOfContacts

integer

NumberOfConvertedLeads

integer

NumberOfLeads

integer

NumberOfOpportunities

integer

NumberOfResponses

integer

NumberOfWonOpportunities

integer

NumberSent

integer

OwnerId

string

ParentId

string

StartDate

string

Status

string

SystemModstamp

string

Type

string

attributes__type

string

attributes__url

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create lead

SLUG: SALESFORCE_CREATE_LEAD_WITH_SPECIFIED_CONTENT_TYPE

Creates a new lead in salesforce, requiring `lastname` and `company` unless person accounts are enabled and `company` is null.

Action Parameters

AnnualRevenue

integer

City

string

CleanStatus

string

Company

string

CompanyDunsNumber

string

ConvertedAccountId

string

ConvertedContactId

string

ConvertedDate

string

ConvertedOpportunityId

string

Country

string

CreatedById

string

CreatedDate

string

CurrentGenerators__c

string

DandbCompanyId

string

Description

string

EmailBouncedDate

string

EmailBouncedReason

string

FirstName

string

IndividualId

string

Industry

string

IsConverted

boolean

IsDeleted

boolean

IsPriorityRecord

boolean

IsUnreadByOwner

boolean

Jigsaw

string

JigsawContactId

string

LastActivityDate

string

LastModifiedById

string

LastModifiedDate

string

LastName

string

LastReferencedDate

string

LastViewedDate

string

LeadSource

string

MasterRecordId

string

NumberOfEmployees

integer

NumberofLocations__c

integer

OwnerId

string

Phone

string

PhotoUrl

string

PostalCode

string

Primary__c

string

ProductInterest__c

string

Rating

string

SICCode__c

string

Salutation

string

State

string

Status

string

Street

string

SystemModstamp

string

Title

string

Website

string

attributes__type

string

attributes__url

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create a note record

SLUG: SALESFORCE_CREATE_NOTE_RECORD_WITH_CONTENT_TYPE_HEADER

Creates a new note record in salesforce, associated with an existing salesforce object via `parentid`, automatically including a `content-type: application/json` header.

Action Parameters

Body

stringRequired

CreatedById

string

CreatedDate

string

IsDeleted

boolean

IsPrivate

boolean

LastModifiedById

string

LastModifiedDate

string

OwnerId

string

ParentId

stringRequired

SystemModstamp

string

Title

stringRequired

attributes__type

string

attributes__url

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Execute SOQL query

SLUG: SALESFORCE_EXECUTE_SOQL_QUERY

Executes the provided soql query against salesforce; the query must begin with 'select'.

Action Parameters

soql_query

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Fetch modified or unmodified sobjects

SLUG: SALESFORCE_FETCH_MODIFIED_OR_UNMODIFIED_SOBJECTS

Fetches sobjects from `/sobjects` based on caller-set 'if-modified-since' (returns objects modified after a date, or 304 status if none) or 'if-unmodified-since' (returns objects if unmodified since a date, or 412 status if modified) http headers.

Action Parameters

If-Modified-Since

string

If-Unmodified-Since

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Query contacts by name

SLUG: SALESFORCE_QUERY_CONTACTS_BY_NAME

Finds salesforce contact records by name using a case-insensitive search.

Action Parameters

contact_name

stringRequired

fields

stringDefaults to Id,Name,Email,Phone,AccountId

limit

integerDefaults to 20

Action Response

data

objectRequired

error

string

successful

booleanRequired

Remove account by unique identifier

SLUG: SALESFORCE_REMOVE_ACCOUNT_BY_UNIQUE_IDENTIFIER

Deletes an existing salesforce account using its unique id, returning an empty response on success (http 204).

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Retrieve account data and error responses

SLUG: SALESFORCE_RETRIEVE_ACCOUNT_DATA_AND_ERROR_RESPONSES

Retrieves comprehensive metadata for the salesforce account sobject, detailing its properties, recent records, and related resource urls.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

Retrieve campaign data with error handling

SLUG: SALESFORCE_RETRIEVE_CAMPAIGN_DATA_WITH_ERROR_HANDLING

Retrieves comprehensive information and metadata for the salesforce campaign sobject, provided it is enabled and accessible in the organization, and features robust error handling.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

Retrieve lead by id

SLUG: SALESFORCE_RETRIEVE_LEAD_BY_ID

Retrieves details for a salesforce lead by its id; the specified lead id must exist in salesforce.

Action Parameters

fields

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Retrieve lead data with various responses

SLUG: SALESFORCE_RETRIEVE_LEAD_DATA_WITH_VARIOUS_RESPONSES

Retrieves lead sobject data from salesforce, such as recently viewed leads or general lead object information.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

Retrieve Note with conditions

SLUG: SALESFORCE_RETRIEVE_NOTE_WITH_CONDITIONS

Retrieves a salesforce note object by its id, optionally specifying which fields to return; the note id must exist.

Action Parameters

fields

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Retrieve opportunities data

SLUG: SALESFORCE_RETRIEVE_OPPORTUNITIES_DATA

Retrieves all available opportunity records, representing potential revenue-generating deals, from salesforce.

Action Parameters

Action Response

data

objectRequired

error

string

successful

booleanRequired

Retrieve specific contact by id

SLUG: SALESFORCE_RETRIEVE_SPECIFIC_CONTACT_BY_ID

Retrieves a salesforce contact by its unique id; the id must correspond to an existing contact record in salesforce.

Action Parameters

fields

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Update contact by id

SLUG: SALESFORCE_UPDATE_CONTACT_BY_ID

Updates specified fields of an existing salesforce contact by its id; at least one field must be provided for modification.

Action Parameters

AccountId

string

AssistantName

string

AssistantPhone

string

Birthdate

string

CleanStatus

string

ContactSource

string

CreatedById

string

CreatedDate

string

Department

string

Description

string

EmailBouncedDate

string

EmailBouncedReason

string

Fax

string

FirstName

string

HomePhone

string

IndividualId

string

IsDeleted

boolean

IsEmailBounced

boolean

IsPriorityRecord

boolean

Jigsaw

string

JigsawContactId

string

Languages__c

string

LastActivityDate

string

LastCURequestDate

string

LastCUUpdateDate

string

LastModifiedById

string

LastModifiedDate

string

LastName

string

LastReferencedDate

string

LastViewedDate

string

LeadSource

string

Level__c

string

MailingCity

string

MailingCountry

string

MailingGeocodeAccuracy

string

MailingLatitude

integer

MailingLongitude

integer

MailingPostalCode

string

MailingState

string

MailingStreet

string

MasterRecordId

string

MobilePhone

string

Name

string

OtherCity

string

OtherCountry

string

OtherGeocodeAccuracy

string

OtherLatitude

integer

OtherLongitude

integer

OtherPhone

string

OtherPostalCode

string

OtherState

string

OtherStreet

string

OwnerId

string

Phone

string

PhotoUrl

string

ReportsToId

string

Salutation

string

SystemModstamp

string

Title

string

attributes__type

string

attributes__url

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create a new contact with JSON header

SLUG: SALESFORCE_CREATE_NEW_CONTACT_WITH_JSON_HEADER

Creates a new contact in salesforce; 'lastname' is required, an existing 'accountid' must be used if provided, and any custom fields (ending with '  c') must be predefined.

Action Parameters

AccountId

string

AssistantName

string

AssistantPhone

string

Birthdate

string

CleanStatus

string

ContactSource

string

CreatedById

string

CreatedDate

string

Department

string

Description

string

EmailBouncedDate

string

EmailBouncedReason

string

Fax

string

FirstName

string

HomePhone

string

IndividualId

string

IsDeleted

boolean

IsEmailBounced

boolean

IsPriorityRecord

boolean

Jigsaw

string

JigsawContactId

string

Languages__c

string

LastActivityDate

string

LastCURequestDate

string

LastCUUpdateDate

string

LastModifiedById

string

LastModifiedDate

string

LastName

string

LastReferencedDate

string

LastViewedDate

string

LeadSource

string

Level__c

string

MailingCity

string

MailingCountry

string

MailingGeocodeAccuracy

string

MailingLatitude

integer

MailingLongitude

integer

MailingPostalCode

string

MailingState

string

MailingStreet

string

MasterRecordId

string

MobilePhone

string

Name

string

OtherCity

string

OtherCountry

string

OtherGeocodeAccuracy

string

OtherLatitude

integer

OtherLongitude

integer

OtherPhone

string

OtherPostalCode

string

OtherState

string

OtherStreet

string

OwnerId

string

Phone

string

PhotoUrl

string

ReportsToId

string

Salutation

string

SystemModstamp

string

Title

string

attributes__type

string

attributes__url

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Create opportunity record

SLUG: SALESFORCE_CREATE_OPPORTUNITY_RECORD

Creates a new opportunity record in salesforce; `name`, `stagename`, and `closedate` are mandatory, and ensure any referenced ids (e.g., `accountid`, `campaignid`) are valid and corresponding salesforce features are enabled if used.

Action Parameters

AccountId

string

Amount

integer

CampaignId

string

CloseDate

string

ContactId

string

CreatedById

string

CreatedDate

string

CurrentGenerators__c

string

DeliveryInstallationStatus__c

string

Description

string

ExpectedRevenue

integer

Fiscal

string

FiscalQuarter

integer

FiscalYear

integer

ForecastCategory

string

ForecastCategoryName

string

HasOpenActivity

boolean

HasOpportunityLineItem

boolean

HasOverdueTask

boolean

string

IsClosed

boolean

IsDeleted

boolean

IsPrivate

boolean

IsWon

boolean

LastActivityDate

string

LastAmountChangedHistoryId

string

LastCloseDateChangedHistoryId

string

LastModifiedById

string

LastModifiedDate

string

LastReferencedDate

string

LastStageChangeDate

string

LastViewedDate

string

LeadSource

string

MainCompetitors__c

string

Name

string

NextStep

string

OrderNumber__c

string

OwnerId

string

Pricebook2Id

string

Probability

integer

PushCount

integer

StageName

string

SystemModstamp

string

TotalOpportunityQuantity

integer

TrackingNumber__c

string

Type

string

attributes__type

string

attributes__url

string

Action Response

data

objectRequired

error

string

successful

booleanRequired

Delete a lead object by its id

SLUG: SALESFORCE_DELETE_A_LEAD_OBJECT_BY_ITS_ID

Permanently deletes an existing lead object from salesforce using its unique id.

Action Parameters

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired

Fetch account by ID with query

SLUG: SALESFORCE_FETCH_ACCOUNT_BY_ID_WITH_QUERY

Use this action to retrieve a salesforce account by its unique id, which must be a valid and existing salesforce account id; you can optionally specify a comma-delimited list of fields to return.

Action Parameters

fields

string

stringRequired

Action Response

data

objectRequired

error

string

successful

booleanRequired