Skip to main content

Salesforce Component

Query, create, update or delete Salesforce records

Component key: salesforce

Description#

Salesforce is a customer relationship management (CRM) platform. This component gives you the ability to manage sales leads and records within the Salesforce platform.

This component includes CRUD (create, read, update, delete) actions for records and a create action for leads. For more complex queries, you can use Salesforce Object Query Language and the query action of this component.

Authorization Notes#

The Salesforce component supports Basic Auth and OAuth 2.0.

Basic Auth#

If you select Basic Auth, you will need to supply your Salesforce username and a password. Depending on your Salesforce setup, your password may have a security token attached to it. If security tokens in your Salesforce account are disabled, the password you need to supply is simply your Salesforce password. If security tokens are enabled in your Salesforce account, then the password you need to enter is the concatenation of your password and your security token.

For example, if your Salesforce password is p@$sw0rD and the security token that Salesforce provides is ExAmPlE0000000000ExAmPlE, then you should enter p@$sw0rDExAmPlE0000000000ExAmPlE as your password in Prismatic. You can manage security tokens by clicking your profile picture on the top-right of Salesforce, select My Settings, and then open Personal -> Reset My Security Token.

OAuth 2.0#

If you select OAuth 2.0, you will need to create and configure a Connected App within Salesforce. When you create your "Connected App" be sure to check Enable OAuth Settings, and enter Prismatic's OAuth callback URL - https://oauth2.prismatic.io/callback - as a Callback URL. Consult Salesforce to determine the proper OAuth Scopes to assign - to grant your integrations the same permissions that the user authenticating through OAuth has, select Full access (full). Select Require Secret for Web Server Flow and Require Secret for Refresh Token Flow:

Once the app has been created, you will be provided with a Consumer Key and Consumer Secret. Take note of these keys:

Now, configure OAuth 2.0 settings in Prismatic. Create a new credential of type OAuth 2.0 - Authorization Code.

  • For Client ID and Client Secret enter the Consumer Key and Consumer Secret that you noted previously
  • Leave Scopes blank
  • For Authorization URL enter https://login.salesforce.com/services/oauth2/authorize
  • For Access Token URL enter https://YOUR-COMPANY.my.salesforce.com/services/oauth2/token, replacing YOUR-COMPANY with your Salesforce URL.

You should now be able to authenticate a user through Salesforce using OAuth 2.0.

Triggers#

Webhook#

Trigger for handling webhook requests from the Salesforce platform. Returns the expected response to Salesforce and converts the XML payload to an object for more convenient use in the rest of the flow. | key: webhook

You can configure a Salesforce outbound message to send information to a Prismatic webhook URL under certain conditions (an "Account" is created, an "Opportunity" is updated, etc.).

This trigger responds to a Salesforce outbound message request with the acknowledgement (ack) response that Salesforce expects.

Since Salesforce always sends XML payloads, the XML is deserialized automatically as part of the trigger, so no additional XML deserialization step is required.


Actions#

Create Account#

Create a Salesforce Account Record | key: createAccount

InputKeyDefaultNotesExample

Billing City

string
billingCityThe city of the object's billing addressCupertino

Billing Country

string
billingCountryThe state of the object's billing addressCA

Billing Postal Code

string
billingPostalCodeThe zip code of the object's billing address94024

Billing State

string
billingStateThe state of the object's billing addressCA

Billing Street Address

string
billingStreetThe street address of the billing object4 Privet Drive

City

string
cityThe city of the object's addressCupertino

Country

string
countryThe country of the object's addressUnited States

Description

string
descriptionProvide a string value for the description of the object

Number of Employees

string
employeeCountThe number of employees associated with the object.30

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

Industry

string
/ Required
industryThe type of account record

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Name

string
/ Required
nameThe name of the objectmyExampleObject

Phone

string
phoneThe primary phone number for the object18005555555

Postal Code

string
postalCodeThe zip code of the object's address94024

Annual Revenue

string
revenueThe estimated annual revenue of the object

State

string
stateThe state of the object's addressCA

Street Address

string
streetThe street address of the object4 Privet Drive

Account Type

string
/ Required
typeThe type of account record

Version

string
version51.0Salesforce API Version Number51.0

Website

string
websiteProvide a valid URL for the website of the objectwebsite-example.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "id": "06Q606ExampleId",    "success": true  }}

Create Contact#

Create a Salesforce contact | key: createContact

InputKeyDefaultNotesExample

Assistant

string
assistantProvide a string value that represents the name of the contact's assistant

Assistant's Phone

string
assistantPhoneProvide a string value that represents the phone number of the contact's assistant

Billing City

string
billingCityThe city of the object's billing addressCupertino

Billing Country

string
billingCountryThe state of the object's billing addressCA

Billing Postal Code

string
billingPostalCodeThe zip code of the object's billing address94024

Billing State

string
billingStateThe state of the object's billing addressCA

Billing Street Address

string
billingStreetThe street address of the billing object4 Privet Drive

Birthdate

string
birthdateProvide a string value that represents the birthdateYYYY-MM-DD

City

string
cityThe city of the object's addressCupertino

Country

string
countryThe country of the object's addressUnited States

Department

string
departmentProvide a string value that represents the name of the contact's department

Description

string
descriptionProvide a string value for the description of the object

Email Address

string
/ Required
emailThe email address for the objectsomeone@example.com

Fax

string
faxProvide a string value for the fax number18008999372

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

First Name

string
firstNameThe first name of the contact at the companyJohn

Last Name

string
lastNameThe last name of the contact at the companySmith

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Mobile Phone

string
mobileThe mobile phone number for the object18005555555

Phone

string
phoneThe primary phone number for the object18005555555

Postal Code

string
postalCodeThe zip code of the object's address94024

State

string
stateThe state of the object's addressCA

Street Address

string
streetThe street address of the object4 Privet Drive

Title

string
titleThe title of the objectExample Title

Version

string
version51.0Salesforce API Version Number51.0

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "id": "06Q606ExampleId",    "success": true  }}

Create Customer#

Create a Salesforce customer account | key: createCustomer

InputKeyDefaultNotesExample

Billing City

string
billingCityThe city of the object's billing addressCupertino

Billing Country

string
billingCountryThe state of the object's billing addressCA

Billing Postal Code

string
billingPostalCodeThe zip code of the object's billing address94024

Billing State

string
billingStateThe state of the object's billing addressCA

Billing Street Address

string
billingStreetThe street address of the billing object4 Privet Drive

City

string
cityThe city of the object's addressCupertino

Country

string
countryThe country of the object's addressUnited States

Description

string
descriptionProvide a string value for the description of the object

Number of Employees

string
employeeCountThe number of employees associated with the object.30

Fax

string
faxProvide a string value for the fax number18008999372

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

Industry

string
/ Required
industryThe type of account record

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Name

string
/ Required
nameThe name of the objectmyExampleObject

Phone

string
phoneThe primary phone number for the object18005555555

Postal Code

string
postalCodeThe zip code of the object's address94024

Rating

string
ratingThe rating for the lead.

Annual Revenue

string
revenueThe estimated annual revenue of the object

State

string
stateThe state of the object's addressCA

Street Address

string
streetThe street address of the object4 Privet Drive

Version

string
version51.0Salesforce API Version Number51.0

Website

string
websiteProvide a valid URL for the website of the objectwebsite-example.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "id": "06Q606ExampleId",    "success": true  }}

Create Lead#

Create a Salesforce Lead Record | key: createLead

InputKeyDefaultNotesExample

City

string
cityThe city of the object's addressCupertino

Company

string
/ Required
companyThe name of the companyWidgets Inc.

Description

string
descriptionProvide a string value for the description of the object

Email Address

string
/ Required
emailThe email address for the objectsomeone@example.com

Number of Employees

string
employeeCountThe number of employees associated with the object.30

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

First Name

string
firstNameThe first name of the contact at the companyJohn

Last Name

string
lastNameThe last name of the contact at the companySmith

Lead Source

string
leadSourceProvide a value for the source of the lead.Web

Lead Status

string
/ Required
leadStatusThe status of the lead. Examples of valid values include: Open, Working, Closed - Converted, Closed - Not ConvertedConverted

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Phone

string
phoneThe primary phone number for the object18005555555

Postal Code

string
postalCodeThe zip code of the object's address94024

Rating

string
ratingThe rating for the lead.

Annual Revenue

string
revenueThe estimated annual revenue of the object

State

string
stateThe state of the object's addressCA

Street Address

string
streetThe street address of the object4 Privet Drive

Title

string
titleThe title of the objectExample Title

Version

string
version51.0Salesforce API Version Number51.0

Website

string
websiteProvide a valid URL for the website of the objectwebsite-example.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "id": "06Q606ExampleId",    "success": true  }}

Create Opportunity#

Create a Salesforce Opportunity Record, which is a sale or pending deal | key: createOpportunity

InputKeyDefaultNotesExample

AccountId

string
accountIdThe Id of the account to reference

Amount

string
amountProvide a number that represents the opportunity amount.38000

Close Date

string
/ Required
closeDateThe date the sale will close.YYYY-MM-DD

Description

string
descriptionProvide a string value for the description of the object

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

Lead Source

string
leadSourceProvide a value for the source of the lead.Web

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Name

string
/ Required
nameThe name of the objectmyExampleObject

Next Step

string
nextStepProvide a string value for the next step of the sale.

Opportunity Type

string
/ Required
opportunityTypeProvide a value for what stage the sales process is in.

Probability

string
probabilityThe probability of the success of the sale09/01/2021

Stage

string
/ Required
stageThe stage the sale is currently in.Prospecting

Version

string
version51.0Salesforce API Version Number51.0

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri

Output Example Payload#

{  "data": {    "id": "06Q606ExampleId",    "success": true  }}

Create Record#

Create a Salesforce Record | key: createRecord

InputKeyDefaultNotesExample

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Record Type

string
/ Required
recordTypeThe type of Salesforce RecordAccount

Version

string
version51.0Salesforce API Version Number51.0

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Account#

Delete an existing account record | key: deleteAccount

InputKeyDefaultNotesExample

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Record ID

string
/ Required
recordIdThe ID of a Salesforce Record0017000000hOMChAAO

Version

string
version51.0Salesforce API Version Number51.0

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Contact#

Delete an existing contact record | key: deleteContact

InputKeyDefaultNotesExample

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Record ID

string
/ Required
recordIdThe ID of a Salesforce Record0017000000hOMChAAO

Version

string
version51.0Salesforce API Version Number51.0

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Customer#

Delete an existing customer account record | key: deleteCustomer

InputKeyDefaultNotesExample

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Record ID

string
/ Required
recordIdThe ID of a Salesforce Record0017000000hOMChAAO

Version

string
version51.0Salesforce API Version Number51.0

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Lead#

Delete a Salesforce Lead Record | key: deleteLead

InputKeyNotesExample

Record ID

string
/ Required
recordIdThe ID of a Salesforce Record0017000000hOMChAAO

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Opportunity#

Delete an existing opportunity record | key: deleteOpportunity

InputKeyDefaultNotesExample

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Record ID

string
/ Required
recordIdThe ID of a Salesforce Record0017000000hOMChAAO

Version

string
version51.0Salesforce API Version Number51.0

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Record#

Delete an existing Salesforce Record | key: deleteRecord

InputKeyDefaultNotesExample

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Record ID

string
/ Required
recordIdThe ID of a Salesforce Record0017000000hOMChAAO

Record Type

string
/ Required
recordTypeThe type of Salesforce RecordAccount

Version

string
version51.0Salesforce API Version Number51.0

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Find Record#

Find a single Salesforce Record | key: findRecord

InputKeyDefaultNotesExample

Values

string
/ Required
fieldValuesThe names of the fields and their values to use when creating/updating a record

Types

string
/ Required
fieldValueTypesFor each item, provide the key and the type of the corresponding field Value you entered above.

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Record Type

string
/ Required
recordTypeThe type of Salesforce RecordAccount

Version

string
version51.0Salesforce API Version Number51.0

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Find Records#

Find and fetch Salesforce Records | key: findRecords

InputKeyDefaultNotesExample

Values

string
/ Required
fieldValuesThe names of the fields and their values to use when creating/updating a record

Types

string
/ Required
fieldValueTypesFor each item, provide the key and the type of the corresponding field Value you entered above.

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Record Type

string
/ Required
recordTypeThe type of Salesforce RecordAccount

Version

string
version51.0Salesforce API Version Number51.0

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Record#

Get a single Salesforce Record by Id | key: getRecord

InputKeyDefaultNotesExample

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Record ID

string
/ Required
recordIdThe ID of a Salesforce Record0017000000hOMChAAO

Record Type

string
/ Required
recordTypeThe type of Salesforce RecordAccount

Version

string
version51.0Salesforce API Version Number51.0

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Salesforce Query#

Run an SOQL Query Against SalesForce | key: query

InputKeyDefaultNotesExample

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

SOQL Query

string
/ Required
queryStringA SalesForce Object Query Language (SOQL) querySELECT Id, Name FROM Opportunity

Version

string
version51.0Salesforce API Version Number51.0

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Account#

Update an existing account record | key: updateAccount

InputKeyDefaultNotesExample

Billing City

string
billingCityThe city of the object's billing addressCupertino

Billing Country

string
billingCountryThe state of the object's billing addressCA

Billing Postal Code

string
billingPostalCodeThe zip code of the object's billing address94024

Billing State

string
billingStateThe state of the object's billing addressCA

Billing Street Address

string
billingStreetThe street address of the billing object4 Privet Drive

City

string
cityThe city of the object's addressCupertino

Country

string
countryThe country of the object's addressUnited States

Description

string
descriptionProvide a string value for the description of the object

Number of Employees

string
employeeCountThe number of employees associated with the object.30

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

Industry

string
/ Required
industryThe type of account record

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Name

string
/ Required
nameThe name of the objectmyExampleObject

Phone

string
phoneThe primary phone number for the object18005555555

Postal Code

string
postalCodeThe zip code of the object's address94024

Record ID

string
/ Required
recordIdThe ID of a Salesforce Record0017000000hOMChAAO

Annual Revenue

string
revenueThe estimated annual revenue of the object

State

string
stateThe state of the object's addressCA

Street Address

string
streetThe street address of the object4 Privet Drive

Account Type

string
/ Required
typeThe type of account record

Version

string
version51.0Salesforce API Version Number51.0

Website

string
websiteProvide a valid URL for the website of the objectwebsite-example.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Contact#

Update an existing contact record | key: updateContact

InputKeyDefaultNotesExample

Assistant

string
assistantProvide a string value that represents the name of the contact's assistant

Assistant's Phone

string
assistantPhoneProvide a string value that represents the phone number of the contact's assistant

Billing City

string
billingCityThe city of the object's billing addressCupertino

Billing Country

string
billingCountryThe state of the object's billing addressCA

Billing Postal Code

string
billingPostalCodeThe zip code of the object's billing address94024

Billing State

string
billingStateThe state of the object's billing addressCA

Billing Street Address

string
billingStreetThe street address of the billing object4 Privet Drive

Birthdate

string
birthdateProvide a string value that represents the birthdateYYYY-MM-DD

City

string
cityThe city of the object's addressCupertino

Country

string
countryThe country of the object's addressUnited States

Department

string
departmentProvide a string value that represents the name of the contact's department

Description

string
descriptionProvide a string value for the description of the object

Email Address

string
/ Required
emailThe email address for the objectsomeone@example.com

Fax

string
faxProvide a string value for the fax number18008999372

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

First Name

string
firstNameThe first name of the contact at the companyJohn

Last Name

string
lastNameThe last name of the contact at the companySmith

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Mobile Phone

string
mobileThe mobile phone number for the object18005555555

Phone

string
phoneThe primary phone number for the object18005555555

Postal Code

string
postalCodeThe zip code of the object's address94024

Record ID

string
/ Required
recordIdThe ID of a Salesforce Record0017000000hOMChAAO

State

string
stateThe state of the object's addressCA

Street Address

string
streetThe street address of the object4 Privet Drive

Title

string
titleThe title of the objectExample Title

Version

string
version51.0Salesforce API Version Number51.0

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Customer#

Update an existing customer account record | key: updateCustomer

InputKeyDefaultNotesExample

Billing City

string
billingCityThe city of the object's billing addressCupertino

Billing Country

string
billingCountryThe state of the object's billing addressCA

Billing Postal Code

string
billingPostalCodeThe zip code of the object's billing address94024

Billing State

string
billingStateThe state of the object's billing addressCA

Billing Street Address

string
billingStreetThe street address of the billing object4 Privet Drive

City

string
cityThe city of the object's addressCupertino

Country

string
countryThe country of the object's addressUnited States

Description

string
descriptionProvide a string value for the description of the object

Number of Employees

string
employeeCountThe number of employees associated with the object.30

Fax

string
faxProvide a string value for the fax number18008999372

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

Industry

string
/ Required
industryThe type of account record

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Name

string
/ Required
nameThe name of the objectmyExampleObject

Phone

string
phoneThe primary phone number for the object18005555555

Postal Code

string
postalCodeThe zip code of the object's address94024

Rating

string
ratingThe rating for the lead.

Record ID

string
/ Required
recordIdThe ID of a Salesforce Record0017000000hOMChAAO

Annual Revenue

string
revenueThe estimated annual revenue of the object

State

string
stateThe state of the object's addressCA

Street Address

string
streetThe street address of the object4 Privet Drive

Version

string
version51.0Salesforce API Version Number51.0

Website

string
websiteProvide a valid URL for the website of the objectwebsite-example.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Lead#

Update a Salesforce Lead Record | key: updateLead

InputKeyDefaultNotesExample

City

string
cityThe city of the object's addressCupertino

Company

string
/ Required
companyThe name of the companyWidgets Inc.

Description

string
descriptionProvide a string value for the description of the object

Email Address

string
/ Required
emailThe email address for the objectsomeone@example.com

Number of Employees

string
employeeCountThe number of employees associated with the object.30

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

First Name

string
firstNameThe first name of the contact at the companyJohn

Last Name

string
lastNameThe last name of the contact at the companySmith

Lead Source

string
leadSourceProvide a value for the source of the lead.Web

Lead Status

string
/ Required
leadStatusThe status of the lead. Examples of valid values include: Open, Working, Closed - Converted, Closed - Not ConvertedConverted

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Phone

string
phoneThe primary phone number for the object18005555555

Postal Code

string
postalCodeThe zip code of the object's address94024

Rating

string
ratingThe rating for the lead.

Record ID

string
/ Required
recordIdThe ID of a Salesforce Record0017000000hOMChAAO

Annual Revenue

string
revenueThe estimated annual revenue of the object

State

string
stateThe state of the object's addressCA

Street Address

string
streetThe street address of the object4 Privet Drive

Title

string
titleThe title of the objectExample Title

Version

string
version51.0Salesforce API Version Number51.0

Website

string
websiteProvide a valid URL for the website of the objectwebsite-example.com

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Opportunity#

Update an existing opportunity record | key: updateOpportunity

InputKeyDefaultNotesExample

AccountId

string
accountIdThe Id of the account to reference

Amount

string
amountProvide a number that represents the opportunity amount.38000

Close Date

string
/ Required
closeDateThe date the sale will close.YYYY-MM-DD

Description

string
descriptionProvide a string value for the description of the object

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

Lead Source

string
leadSourceProvide a value for the source of the lead.Web

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Name

string
/ Required
nameThe name of the objectmyExampleObject

Next Step

string
nextStepProvide a string value for the next step of the sale.

Opportunity Type

string
/ Required
opportunityTypeProvide a value for what stage the sales process is in.

Probability

string
probabilityThe probability of the success of the sale09/01/2021

Record ID

string
/ Required
recordIdThe ID of a Salesforce Record0017000000hOMChAAO

Stage

string
/ Required
stageThe stage the sale is currently in.Prospecting

Version

string
version51.0Salesforce API Version Number51.0

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Record#

Updates an existing Salesforce Record | key: updateRecord

InputKeyDefaultNotesExample

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Record ID

string
/ Required
recordIdThe ID of a Salesforce Record0017000000hOMChAAO

Record Type

string
/ Required
recordTypeThe type of Salesforce RecordAccount

Version

string
version51.0Salesforce API Version Number51.0

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Upsert Record#

Updates a Salesforce Record if it exists, otherwise creates a new Salesforce Record | key: upsertRecord

InputKeyDefaultNotesExample

External ID Field Name

string
/ Required
externalIdFieldNameThe name of the column that refers to the External ID FieldExtId__c

Values

string
fieldValuesThe names of the fields and their values to use when creating/updating a record

Login URL

string
/ Required
loginUrlYour SalesForce Login URL - required for Basic Authhttps://my-company.my.salesforce.com/

Record Type

string
/ Required
recordTypeThe type of Salesforce RecordAccount

Version

string
version51.0Salesforce API Version Number51.0

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri