Salesforce
The Salesforce connector enables seamless integration with Salesforce's CRM platform, allowing for efficient management and automation of CRM data and processes.
Salesforce is a leading customer relationship management (CRM) platform that provides a comprehensive suite of tools for managing customer interactions, sales, and business processes. The Salesforce connector for Swimlane Turbine enables seamless integration with Salesforce, allowing users to automate and streamline CRM operations such as creating, updating, and retrieving records for accounts, contacts, leads, opportunities, and more. This integration enhances security operations by enabling automated workflows that leverage Salesforce data, improving efficiency and reducing manual effort in managing customer-related tasks.
Prerequisites
Before you can use the Salesforce connector for Turbine, you'll need access to Salesforce credentials. This requires the following:
- Custom authentication using Salesforce credentials:
- Username: Your Salesforce account username.
- Password: The password associated with your Salesforce account.
- Instance: The specific Salesforce instance URL you are connecting to.
Capabilities
The Salesforce Connector has the following capabilities:
- Create
- account
- case
- contact
- lead
- opportunity
- task
- user
- case comment
- Delete
- account
- case
- contact
- lead
- opportunity
- task
- user
- Get
- account
- case
- contact
- lead
- opportunity
- task
- user
- report
- case comments
- Update
- account
- case
- contact
- lead
- opportunity
- task
- user
- case comment
- Time Sheet Entry
- Other
- search
- query
- query_range
- Find field names
Retrieve Attachment From Account
There are 2 types of attachments in salesforce, an attachment is is created when you add an attachment through salesforce classic and a file is created when you do it through the lightning experience.
You will need to execute 3 tasks to get a file attachment:
- Salesforce Query
- Use the query SELECT ContentDocumentId FROM ContentDocumentLink WHERE LinkedEntityId = '{account_id}'
- This will return the column ContentDocumentId for each attachment.
- Salesforce Query
- Use the query SELECT Id, Title, FileExtension, PathOnClient FROM ContentVersion WHERE ContentDocumentId = '{ContentDocumentId from previous query}'
- This will return the column Id for the attachment (also the filename in the PathOnClient column).
- Salesforce Get Content Version Data
- pass in the Id from the last query as the ContentVersion Id.
- This task will return the file
You will need to execute 2 tasks to get an attachment attachment:
- Salesforce Query
- Use the query SELECT Id, name FROM Attachment WHERE ParentId = '{account_id}'
- This will return ids and filenames for each attachment
- Get Attachment
- Pass the Id from the query as the Attachment ID.
- This task will return the file.
Sandbox Testing
The Sandbox parameter must be set to True in order to connect to the sandbox org.
Notes
For more information on Salesforce is found at: Salesforce Developer Main Site
Additional Documentation
Configurations
Salesforce Asset - Oauth2 or Refresh Token
Authenticates using Salesforce credentials
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
url | A URL to the target host. | string | Optional |
token_url | ο»Ώ | string | Optional |
username | The username for authentication | string | Required |
password | The password for authentication | string | Required |
client_id | The client ID | string | Optional |
client_secret | The client secret. | string | Optional |
scope | Permission scopes for this action. | array | Optional |
verify_ssl | Verify SSL certificate | boolean | Optional |
http_proxy | A proxy to route requests through. | string | Optional |
security_token_or_refresh_token | Security Token from your user>settings>security token or Refresh Token (not for Oauth2) | string | Optional |
instance | Your Salesforce Instance. | string | Required |
auth_site | string | Optional | |
oauth2 | Set to True if using Oauth2 | boolean | Optional |
sandbox | Set to True for connecting to a sandbox. | boolean | Optional |
Actions
Get Attachment
Retrieve a specified attachment file from Salesforce using the provided attachment ID.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
attachment_ids | array | Required | Unique identifier |
filename | string | Optional | Name of the resource |
Input Example
{"attachment_ids":["0688c000008G958AAC"],"filename":"test.pdf, test.txt, etc."}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
attachments | array | Output field: attachments |
attachments.file_name | string | Name of the resource |
attachments.file | string | Output field: attachments.file |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"attachments":[]}}
Create Account
Create a new account in Salesforce using the provided Name field.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
ShippingState | string | Optional | Parameter for Create Account |
AnnualRevenue | string | Optional | Parameter for Create Account |
Tradestyle | string | Optional | Parameter for Create Account |
MasterRecordId | string | Optional | Unique identifier |
YearStarted | string | Optional | Parameter for Create Account |
BillingGeocodeAccuracy | string | Optional | Parameter for Create Account |
ShippingCountry | string | Optional | Parameter for Create Account |
LastModifiedById | string | Optional | Unique identifier |
JigsawCompanyId | string | Optional | Unique identifier |
Sic | string | Optional | Parameter for Create Account |
ShippingPostalCode | string | Optional | Parameter for Create Account |
SLA__c | string | Optional | Parameter for Create Account |
Attributes_url | string | Optional | URL endpoint for the request |
OwnerId | string | Optional | Unique identifier |
SLAExpirationDate__c | string | Optional | Parameter for Create Account |
Type | string | Optional | Type of the resource |
BillingCity | string | Optional | Parameter for Create Account |
Website | string | Optional | Parameter for Create Account |
ShippingAddress | string | Optional | Parameter for Create Account |
Fax | string | Optional | Parameter for Create Account |
AccountSource | string | Optional | Parameter for Create Account |
NaicsDesc | string | Optional | Parameter for Create Account |
ShippingLatitude | string | Optional | Parameter for Create Account |
NumberOfEmployees | string | Optional | Parameter for Create Account |
PhotoUrl | string | Optional | URL endpoint for the request |
Input Example
{"ShippingState":"string","AnnualRevenue":"string","Tradestyle":"string","MasterRecordId":"string","YearStarted":"string","BillingGeocodeAccuracy":"string","ShippingCountry":"string","LastModifiedById":"string","JigsawCompanyId":"string","Sic":"string","ShippingPostalCode":"string","SLA__c":"string","Attributes_url":"string","OwnerId":"string","SLAExpirationDate__c":"string","Type":"string","BillingCity":"string","Website":"string","ShippingAddress":"string","Fax":"string","AccountSource":"string","NaicsDesc":"string","ShippingLatitude":"string","NumberOfEmployees":"string","PhotoUrl":"string","LastModifiedDate":"string","LastReferencedDate":"string","BillingState":"string","Phone":"string","CreatedById":"string","Ownership":"string","BillingCountry":"string","Attributes_type":"string","LastViewedDate":"string","DandbCompanyId":"string","IsDeleted":"string","BillingAddress":"string","Jigsaw":"string","Name":"Example Name","NumberofLocations__c":"string","Industry":"string","SicDesc":"string","DunsNumber":"string","BillingStreet":"string","ParentId":"string","CustomerPriority__c":"string","ShippingCity":"string","ShippingLongitude":"string","BillingLatitude":"string","Description":"string"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | array | Unique identifier |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"id":["string"],"success":true}}
Create Case
Initiate the creation of a new case in Salesforce using the required 'Subject' field.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
Subject | string | Required | Parameter for Create Case |
SuppliedCompany | string | Optional | Parameter for Create Case |
Description | string | Optional | Parameter for Create Case |
Priority | string | Optional | Parameter for Create Case |
OwnerId | string | Optional | Unique identifier |
Type | string | Optional | Type of the resource |
Status | string | Optional | Status value |
IsEscalated | number | Optional | Parameter for Create Case |
SuppliedPhone | string | Optional | Parameter for Create Case |
ContactId | string | Optional | Unique identifier |
Reason | string | Optional | Response reason phrase |
SuppliedName | string | Optional | Name of the resource |
SuppliedEmail | string | Optional | Parameter for Create Case |
AccountId | string | Optional | Unique identifier |
ParentId | string | Optional | Unique identifier |
Origin | string | Optional | Parameter for Create Case |
Input Example
{"Priority":"High","OwnerId":"0054T000000LLnUQAW","Type":"Feature Request","Status":"New","IsEscalated":0,"SuppliedPhone":"(111) 111-1111","ContactId":"0054T000000LLnUQAW","AccountId":"0054T000000LLnUQAW","ParentId":"0054T000000LLnUQAW","Origin":"Phone"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | string | Unique identifier |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"id":"string","success":true}}
Create Contact
Create a new contact record in Salesforce using the required 'LastName' field.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
IsDeleted | string | Optional | Parameter for Create Contact |
MasterRecordId | string | Optional | Unique identifier |
AccountId | string | Optional | Unique identifier |
LastName | string | Required | Name of the resource |
FirstName | string | Optional | Name of the resource |
Salutation | string | Optional | Parameter for Create Contact |
Name | string | Optional | Name of the resource |
OtherStreet | string | Optional | Parameter for Create Contact |
OtherCity | string | Optional | Parameter for Create Contact |
OtherState | string | Optional | Parameter for Create Contact |
OtherPostalCode | string | Optional | Parameter for Create Contact |
OtherCountry | string | Optional | Parameter for Create Contact |
OtherLatitude | string | Optional | Parameter for Create Contact |
OtherLongitude | string | Optional | Parameter for Create Contact |
OtherGeocodeAccuracy | string | Optional | Parameter for Create Contact |
OtherAddress | string | Optional | Parameter for Create Contact |
MailingStreet | string | Optional | Parameter for Create Contact |
MailingCity | string | Optional | Parameter for Create Contact |
MailingState | string | Optional | Parameter for Create Contact |
MailingPostalCode | string | Optional | Parameter for Create Contact |
MailingCountry | string | Optional | Parameter for Create Contact |
MailingLatitude | string | Optional | Parameter for Create Contact |
MailingLongitude | string | Optional | Parameter for Create Contact |
MailingGeocodeAccuracy | string | Optional | Parameter for Create Contact |
MailingAddress | string | Optional | Parameter for Create Contact |
Input Example
{"IsDeleted":"string","MasterRecordId":"string","AccountId":"string","LastName":"Example Name","FirstName":"Example Name","Salutation":"string","Name":"Example Name","OtherStreet":"string","OtherCity":"string","OtherState":"string","OtherPostalCode":"string","OtherCountry":"string","OtherLatitude":"string","OtherLongitude":"string","OtherGeocodeAccuracy":"string","OtherAddress":"string","MailingStreet":"string","MailingCity":"string","MailingState":"string","MailingPostalCode":"string","MailingCountry":"string","MailingLatitude":"string","MailingLongitude":"string","MailingGeocodeAccuracy":"string","MailingAddress":"string","Phone":"string","Fax":"string","MobilePhone":"string","HomePhone":"string","OtherPhone":"string","AssistantPhone":"string","ReportsToId":"string","Email":"[email protected]","Title":"string","Department":"string","AssistantName":"Example Name","LeadSource":"string","Birthdate":"string","Description":"string","OwnerId":"string","CreatedDate":"string","CreatedById":"string","LastModifiedDate":"string","LastModifiedById":"string","SystemModstamp":"string","LastActivityDate":"string","LastCURequestDate":"string","LastCUUpdateDate":"string","LastViewedDate":"string","LastReferencedDate":"string"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | string | Unique identifier |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"id":"string","success":true}}
Create Lead
Create a new lead in Salesforce using the required Last Name and Company fields.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
ConvertedOpportunityId | string | Optional | Unique identifier |
City | string | Optional | Parameter for Create Lead |
AnnualRevenue | string | Optional | Parameter for Create Lead |
JigsawContactId | string | Optional | Unique identifier |
MasterRecordId | string | Optional | Unique identifier |
FirstName | string | Optional | Name of the resource |
Title | string | Optional | Parameter for Create Lead |
LastName | string | Required | Name of the resource |
LastReferencedDate | string | Optional | Date value |
LastModifiedById | string | Optional | Unique identifier |
ConvertedAccountId | string | Optional | Unique identifier |
IsUnreadByOwner | string | Optional | Parameter for Create Lead |
State | string | Optional | Parameter for Create Lead |
Attributes_url | string | Optional | URL endpoint for the request |
Latitude | string | Optional | Parameter for Create Lead |
OwnerId | string | Optional | Unique identifier |
string | Optional | Parameter for Create Lead | |
SICCode__c | string | Optional | Parameter for Create Lead |
Website | string | Optional | Parameter for Create Lead |
Fax | string | Optional | Parameter for Create Lead |
Description | string | Optional | Parameter for Create Lead |
NumberOfEmployees | string | Optional | Parameter for Create Lead |
PhotoUrl | string | Optional | URL endpoint for the request |
LastModifiedDate | string | Optional | Date value |
Company | string | Required | Parameter for Create Lead |
Input Example
{"ConvertedOpportunityId":"string","City":"string","AnnualRevenue":"string","JigsawContactId":"string","MasterRecordId":"string","FirstName":"Example Name","Title":"string","LastName":"Example Name","LastReferencedDate":"string","LastModifiedById":"string","ConvertedAccountId":"string","IsUnreadByOwner":"string","State":"string","Attributes_url":"string","Latitude":"string","OwnerId":"string","Email":"[email protected]","SICCode__c":"string","Website":"string","Fax":"string","Description":"string","NumberOfEmployees":"string","PhotoUrl":"string","LastModifiedDate":"string","Company":"string","GeocodeAccuracy":"string","Phone":"string","ConvertedContactId":"string","ConvertedDate":"string","Address":"string","Attributes_type":"string","LastViewedDate":"string","DandbCompanyId":"string","IsDeleted":"string","Status":"active","Jigsaw":"string","Name":"Example Name","EmailBouncedDate":"string","Country":"string","Industry":"string","CreatedById":"string","Longitude":"string","LeadSource":"string","ProductInterest__c":"string","IsConverted":"string","PostalCode":"string","Primary__c":"string","CompanyDunsNumber":"string","Rating":"string","MobilePhone":"string"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | array | Unique identifier |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"id":["string"],"success":true}}
Create Opportunity
Create a new sales opportunity in Salesforce with essential details such as Close Date, Stage Name, and Opportunity Name.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
HasOpenActivity | string | Optional | Parameter for Create Opportunity |
FiscalQuarter | string | Optional | Parameter for Create Opportunity |
LastModifiedById | string | Optional | Unique identifier |
Attributes_url | string | Optional | URL endpoint for the request |
CloseDate | string | Required | Date value |
OrderNumber__c | string | Optional | Parameter for Create Opportunity |
Type | string | Optional | Type of the resource |
Description | string | Optional | Parameter for Create Opportunity |
StageName | string | Required | Name of the resource |
CampaignId | string | Optional | Unique identifier |
LastModifiedDate | string | Optional | Date value |
ForecastCategoryName | string | Optional | Name of the resource |
CreatedById | string | Optional | Unique identifier |
MainCompetitors__c | string | Optional | Parameter for Create Opportunity |
Attributes_type | string | Optional | Type of the resource |
LastViewedDate | string | Optional | Date value |
IsDeleted | string | Optional | Parameter for Create Opportunity |
AccountId | string | Optional | Unique identifier |
Fiscal | string | Optional | Parameter for Create Opportunity |
Name | string | Required | Name of the resource |
CurrentGenerators__c | string | Optional | Parameter for Create Opportunity |
FiscalYear | string | Optional | Parameter for Create Opportunity |
IsWon | string | Optional | Parameter for Create Opportunity |
TrackingNumber__c | string | Optional | Parameter for Create Opportunity |
Amount | string | Optional | Parameter for Create Opportunity |
Input Example
{"HasOpenActivity":"string","FiscalQuarter":"string","LastModifiedById":"string","Attributes_url":"string","CloseDate":"string","OrderNumber__c":"string","Type":"string","Description":"string","StageName":"Example Name","CampaignId":"string","LastModifiedDate":"string","ForecastCategoryName":"Example Name","CreatedById":"string","MainCompetitors__c":"string","Attributes_type":"string","LastViewedDate":"string","IsDeleted":"string","AccountId":"string","Fiscal":"string","Name":"Example Name","CurrentGenerators__c":"string","FiscalYear":"string","IsWon":"string","TrackingNumber__c":"string","Amount":"string","LeadSource":"string","LastReferencedDate":"string","IsPrivate":"string","TotalOpportunityQuantity":"string","Pricebook2Id":"string","DeliveryInstallationStatus__c":"active","Probability":"string","LastActivityDate":"string","HasOpportunityLineItem":"string","IsClosed":"string","NextStep":"string","SystemModstamp":"string","CreatedDate":"string","OwnerId":"string","HasOverdueTask":"string","ForecastCategory":"string","ExpectedRevenue":"string"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | array | Unique identifier |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"id":["string"],"success":true}}
Create Task
Create a new task in Salesforce with a specified subject as a mandatory field.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
CallDurationInSeconds | string | Optional | Parameter for Create Task |
CallObject | string | Optional | Parameter for Create Task |
LastModifiedById | string | Optional | Unique identifier |
Priority | string | Optional | Parameter for Create Task |
RecurrenceType | string | Optional | Type of the resource |
Attributes_url | string | Optional | URL endpoint for the request |
OwnerId | string | Optional | Unique identifier |
IsRecurrence | string | Optional | Parameter for Create Task |
Status | string | Optional | Status value |
CallDisposition | string | Optional | Parameter for Create Task |
RecurrenceStartDateOnly | string | Optional | Parameter for Create Task |
RecurrenceDayOfWeekMask | string | Optional | Parameter for Create Task |
Description | string | Optional | Parameter for Create Task |
RecurrenceInstance | string | Optional | Parameter for Create Task |
LastModifiedDate | string | Optional | Date value |
WhoId | string | Optional | Unique identifier |
CreatedById | string | Optional | Unique identifier |
ActivityDate | string | Optional | Date value |
Attributes_type | string | Optional | Type of the resource |
IsHighPriority | string | Optional | Parameter for Create Task |
IsDeleted | string | Optional | Parameter for Create Task |
AccountId | string | Optional | Unique identifier |
CallType | string | Optional | Type of the resource |
WhatId | string | Optional | Unique identifier |
TaskSubtype | string | Optional | Type of the resource |
Input Example
{"CallDurationInSeconds":"string","CallObject":"string","LastModifiedById":"string","Priority":"string","RecurrenceType":"string","Attributes_url":"string","OwnerId":"string","IsRecurrence":"string","Status":"active","CallDisposition":"string","RecurrenceStartDateOnly":"string","RecurrenceDayOfWeekMask":"string","Description":"string","RecurrenceInstance":"string","LastModifiedDate":"string","WhoId":"string","CreatedById":"string","ActivityDate":"string","Attributes_type":"string","IsHighPriority":"string","IsDeleted":"string","AccountId":"string","CallType":"string","WhatId":"string","TaskSubtype":"string","IsArchived":"string","RecurrenceRegeneratedType":"string","RecurrenceTimeZoneSidKey":"string","RecurrenceMonthOfYear":"string","IsReminderSet":"string","RecurrenceDayOfMonth":"string","IsClosed":"string","ReminderDateTime":"string","SystemModstamp":"string","RecurrenceEndDateOnly":"string","CreatedDate":"string","RecurrenceInterval":"string","Id":"12345678-1234-1234-1234-123456789abc","RecurrenceActivityId":"string","Subject":"string"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | array | Unique identifier |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"id":["string"],"success":true}}
Create User
Create a new user in Salesforce with essential details like email, username, and profile ID. Ensure all required fields are provided.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
UserPreferencesDisableChangeCommentEmail | string | Optional | Parameter for Create User |
Title | string | Optional | Parameter for Create User |
EmailPreferencesAutoBcc | string | Optional | Parameter for Create User |
Department | string | Optional | Parameter for Create User |
MediumPhotoUrl | string | Optional | URL endpoint for the request |
Fax | string | Optional | Parameter for Create User |
UserPreferencesHideEndUserOnboardingAssistantModal | string | Optional | Unique identifier |
UserType | string | Optional | Type of the resource |
UserPreferencesHideLightningMigrationModal | string | Optional | Unique identifier |
UserPreferencesDisableFeedbackEmail | string | Optional | Parameter for Create User |
UserPreferencesPathAssistantCollapsed | string | Optional | Parameter for Create User |
UserPreferencesSortFeedByComment | string | Optional | Parameter for Create User |
UserPreferencesDisableMessageEmail | string | Optional | Response message |
UserPreferencesDisCommentAfterLikeEmail | string | Optional | Parameter for Create User |
UserPreferencesShowPostalCodeToGuestUsers | string | Optional | Parameter for Create User |
Address_state | string | Optional | Parameter for Create User |
CallCenterId | string | Optional | Unique identifier |
EmailEncodingKey | string | Required | Parameter for Create User |
Address_street | string | Optional | Parameter for Create User |
AccountId | string | Optional | Unique identifier |
SmallBannerPhotoUrl | string | Optional | URL endpoint for the request |
JigsawImportLimitOverride | string | Optional | Unique identifier |
EmailPreferencesAutoBccStayInTouch | string | Optional | Parameter for Create User |
Longitude | string | Optional | Parameter for Create User |
UserPreferencesShowStreetAddressToExternalUsers | string | Optional | Parameter for Create User |
Input Example
{"UserPreferencesDisableChangeCommentEmail":"string","Title":"string","EmailPreferencesAutoBcc":"string","Department":"string","MediumPhotoUrl":"string","Fax":"string","UserPreferencesHideEndUserOnboardingAssistantModal":"string","UserType":"string","UserPreferencesHideLightningMigrationModal":"string","UserPreferencesDisableFeedbackEmail":"string","UserPreferencesPathAssistantCollapsed":"string","UserPreferencesSortFeedByComment":"string","UserPreferencesDisableMessageEmail":"string","UserPreferencesDisCommentAfterLikeEmail":"string","UserPreferencesShowPostalCodeToGuestUsers":"string","Address_state":"string","CallCenterId":"string","EmailEncodingKey":"string","Address_street":"string","AccountId":"string","SmallBannerPhotoUrl":"string","JigsawImportLimitOverride":"string","EmailPreferencesAutoBccStayInTouch":"string","Longitude":"string","UserPreferencesShowStreetAddressToExternalUsers":"string","LastReferencedDate":"string","UserPermissionsMarketingUser":"string","LastViewedDate":"string","UserPermissionsSFContentUser":"string","MobilePhone":"string","TimeZoneSidKey":"string","ForecastEnabled":"string","UserPreferencesShowFaxToGuestUsers":"string","UserPreferencesEnableAutoSubForFeeds":"string","AboutMe":"string","UserPreferencesShowProfilePicToGuestUsers":"string","CommunityNickname":"Example Name","UserPreferencesDisableLikeEmail":"string","StayInTouchSignature":"string","IsActive":"string","UserPreferencesShowPostalCodeToExternalUsers":"string","UserPreferencesHideS1BrowserUI":"string","UserPreferencesDisableLaterCommentEmail":"string","BadgeText":"string","UserPreferencesShowWorkPhoneToExternalUsers":"string","State":"string","UserPreferencesDisableWorkEmail":"string","Latitude":"string","UserPreferencesLightningExperiencePreferred":"string","Address_geocodeAccuracy":"string"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | array | Unique identifier |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"id":["string"],"success":true}}
Delete Account
Delete a specified Salesforce account using the provided unique identifier.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
input_id | string | Required | Input data for the action |
Input Example
{"input_id":"5004T000000dv2lQAA"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"success":true}}
Delete Case
Delete an existing case from Salesforce using the specified case ID provided as input.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
input_id | string | Required | Input data for the action |
Input Example
{"input_id":"5004T000000dv2lQAA"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"success":true}}
Delete Contact
Remove a specified contact from Salesforce using the unique identifier provided as input.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
input_id | string | Required | Input data for the action |
Input Example
{"input_id":"5004T000000dv2lQAA"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"success":true}}
Delete Document
Remove a specified document from Salesforce using the provided document ID.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
document_id | string | Required | Unique identifier |
Input Example
{"document_id":"0158c000001l03bAAA"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
message | string | Response message |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"message":"string"}}
Delete Lead
Remove a specified lead from Salesforce using the provided unique identifier (ID).
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
input_id | string | Required | Input data for the action |
Input Example
{"input_id":"5004T000000dv2lQAA"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"success":true}}
Delete Opportunity
Remove a specified opportunity from Salesforce using the unique identifier provided as input.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
input_id | string | Required | Input data for the action |
Input Example
{"input_id":"5004T000000dv2lQAA"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"success":true}}
Delete Task
Deletes a specified task from Salesforce using the provided unique identifier.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
input_id | string | Required | Input data for the action |
Input Example
{"input_id":"5004T000000dv2lQAA"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"success":true}}
Delete User
Deletes a specified user from Salesforce using their unique ID as input.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
input_id | string | Required | Input data for the action |
Input Example
{"input_id":"5004T000000dv2lQAA"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"success":true}}
Get Account
Retrieve a specific Salesforce account using the provided unique identifier (ID).
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
input_id | string | Required | Input data for the action |
Input Example
{"input_id":"5004T000000dv2lQAA"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get Case
Retrieve a specific Salesforce case using the provided case ID.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
case_id | string | Required | Unique identifier |
Input Example
{"case_id":"5004T000000dv2lQAA"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get Case Comments
Retrieve all comments and feeds associated with a specific Salesforce case using the provided case ID.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
case_id | string | Required | Unique identifier |
Input Example
{"case_id":"5003m000011Q8flAAC"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
case_comments | string | Output field: case_comments |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"case_comments":"string"}}
Get Contact
Retrieve a Salesforce contact's details using the specified unique identifier (ID).
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
input_id | string | Required | Input data for the action |
Input Example
{"input_id":"5004T000000dv2lQAA"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get Content Version Data
Retrieve file data stored in Salesforce ContentVersion using specified content version IDs.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
content_version_ids | array | Required | Unique identifier |
filename | string | Optional | Name of the resource |
Input Example
{"content_version_ids":["0688c000008G958AAC"],"filename":"test.pdf, test.txt, etc."}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
files | array | Output field: files |
files.file_name | string | Name of the resource |
files.file | string | Output field: files.file |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"files":[]}}
Get Document
Retrieve a specific document from Salesforce using the provided document ID.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
document_id | string | Required | Unique identifier |
filename | string | Optional | Name of the resource |
Input Example
{"document_id":"0158c000001l03bAAA","filename":"test.pdf, test.txt, etc."}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
file | array | Output field: file |
file.file_name | string | Name of the resource |
file.file | string | Output field: file.file |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"file":[]}}
Get Lead
Retrieve a specific lead from Salesforce using the provided unique identifier.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
input_id | string | Required | Input data for the action |
Input Example
{"input_id":"string"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get Opportunity
Retrieve details of a specific Salesforce opportunity using its unique ID.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
input_id | string | Required | Input data for the action |
Input Example
{"input_id":"5004T000000dv2lQAA"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get Report
Retrieve a specified Salesforce report using the unique identifier provided as input.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
input_id | string | Required | Input data for the action |
Input Example
{"input_id":"5004T000000dv2lQAA"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get Task
Retrieve a specific Salesforce task using the provided unique identifier (ID).
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
input_id | string | Required | Input data for the action |
Input Example
{"input_id":"5004T000000dv2lQAA"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Get User
Retrieve a Salesforce user's details using their unique identifier (ID). Requires 'input_id' to execute.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
input_id | string | Required | Input data for the action |
Input Example
{"input_id":"5004T000000dv2lQAA"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Post Case Comment
Post a new comment to a Salesforce case using ParentId, CommentBody, and IsPublished status.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
ParentId | string | Required | Unique identifier |
CommentBody | string | Required | Request body data |
IsPublished | boolean | Required | Parameter for Post Case Comment |
Input Example
{"ParentId":"5003m000011Q8flAAC","CommentBody":"Swimlane Automation","IsPublished":true}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | string | Unique identifier |
success | boolean | Whether the operation was successful |
errors | array | Error message if any |
errors.file_name | string | Name of the resource |
errors.file | string | Error message if any |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"id":"string","success":true,"errors":[]}}
Query
Execute a Salesforce Object Query Language (SOQL) search to retrieve specific data from Salesforce based on the provided query.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
query | string | Required | Parameter for Query |
Input Example
{"query":"SELECT Id, Email FROM Contact WHERE LastName = 'Smith'"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Ids | string | Unique identifier |
raw_json | object | Output field: raw_json |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Ids":"string","raw_json":{}}}
Query Range
Retrieve Salesforce records where a specified field falls within a defined range. This action requires the 'field' parameter.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
field | string | Required | Parameter for Query Range |
minimum | string | Optional | Parameter for Query Range |
maximum | string | Optional | Parameter for Query Range |
Input Example
{"field":"ClosedDate","minimum":"2019-10-02T10:00:00-08:00","maximum":"2019-10-02T10:00:00-08:00"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Search
Perform a search in Salesforce using a specified key to locate relevant records and information.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
search_key | string | Required | Parameter for Search |
Input Example
{"search_key":"string"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Ids | array | Unique identifier |
Ids.file_name | string | Unique identifier |
Ids.file | string | Unique identifier |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"Ids":[]}}
Search JSON
Retrieve Salesforce search results in JSON format using a specified search key.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
search_key | string | Required | Parameter for Search JSON |
Input Example
{"search_key":"string"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
json | string | Output field: json |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"json":"string"}}
Update Account
Update a Salesforce account using the specified ID to modify account details.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Unique identifier |
do_create | boolean | Optional | Parameter for Update Account |
ShippingState | string | Optional | Parameter for Update Account |
AnnualRevenue | string | Optional | Parameter for Update Account |
Tradestyle | string | Optional | Parameter for Update Account |
MasterRecordId | string | Optional | Unique identifier |
YearStarted | string | Optional | Parameter for Update Account |
BillingGeocodeAccuracy | string | Optional | Parameter for Update Account |
ShippingCountry | string | Optional | Parameter for Update Account |
LastModifiedById | string | Optional | Unique identifier |
JigsawCompanyId | string | Optional | Unique identifier |
Sic | string | Optional | Parameter for Update Account |
ShippingPostalCode | string | Optional | Parameter for Update Account |
SLA__c | string | Optional | Parameter for Update Account |
Attributes_url | string | Optional | URL endpoint for the request |
OwnerId | string | Optional | Unique identifier |
SLAExpirationDate__c | string | Optional | Parameter for Update Account |
Type | string | Optional | Type of the resource |
BillingCity | string | Optional | Parameter for Update Account |
Website | string | Optional | Parameter for Update Account |
ShippingAddress | string | Optional | Parameter for Update Account |
Fax | string | Optional | Parameter for Update Account |
AccountSource | string | Optional | Parameter for Update Account |
NaicsDesc | string | Optional | Parameter for Update Account |
ShippingLatitude | string | Optional | Parameter for Update Account |
Input Example
{"do_create":true}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"success":true}}
Update Case
Update an existing Salesforce case by setting the 'Subject' field using the unique case 'id'.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Unique identifier |
Subject | string | Required | Parameter for Update Case |
SuppliedCompany | string | Optional | Parameter for Update Case |
Description | string | Optional | Parameter for Update Case |
Priority | string | Optional | Parameter for Update Case |
OwnerId | string | Optional | Unique identifier |
Type | string | Optional | Type of the resource |
Status | string | Optional | Status value |
IsEscalated | number | Optional | Parameter for Update Case |
SuppliedPhone | string | Optional | Parameter for Update Case |
ContactId | string | Optional | Unique identifier |
Reason | string | Optional | Response reason phrase |
SuppliedName | string | Optional | Name of the resource |
SuppliedEmail | string | Optional | Parameter for Update Case |
AccountId | string | Optional | Unique identifier |
ParentId | string | Optional | Unique identifier |
Origin | string | Optional | Parameter for Update Case |
Input Example
{"id":"5004T000000dv2lQAA","Priority":"High","OwnerId":"0054T000000LLnUQAW","Type":"Feature Request","Status":"New","IsEscalated":0,"SuppliedPhone":"(111) 111-1111","ContactId":"0054T000000LLnUQAW","AccountId":"0054T000000LLnUQAW","ParentId":"0054T000000LLnUQAW","Origin":"Phone"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"success":true}}
Update Case Comment
Update a specific Salesforce case comment using the provided comment ID.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
comment_id | string | Required | Unique identifier |
CommentBody | string | Optional | Request body data |
IsPublished | boolean | Optional | Parameter for Update Case Comment |
Input Example
{"comment_id":"5003m000011Q8flAAC","CommentBody":"Swimlane Automation","IsPublished":true}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
msg | string | Output field: msg |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"msg":"string","success":true}}
Update Contact
Update a Salesforce contact record using the provided unique identifier (ID).
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Unique identifier |
do_create | boolean | Optional | Parameter for Update Contact |
IsDeleted | string | Optional | Parameter for Update Contact |
MasterRecordId | string | Optional | Unique identifier |
AccountId | string | Optional | Unique identifier |
LastName | string | Optional | Name of the resource |
FirstName | string | Optional | Name of the resource |
Salutation | string | Optional | Parameter for Update Contact |
Name | string | Optional | Name of the resource |
OtherStreet | string | Optional | Parameter for Update Contact |
OtherCity | string | Optional | Parameter for Update Contact |
OtherState | string | Optional | Parameter for Update Contact |
OtherPostalCode | string | Optional | Parameter for Update Contact |
OtherCountry | string | Optional | Parameter for Update Contact |
OtherLatitude | string | Optional | Parameter for Update Contact |
OtherLongitude | string | Optional | Parameter for Update Contact |
OtherGeocodeAccuracy | string | Optional | Parameter for Update Contact |
OtherAddress | string | Optional | Parameter for Update Contact |
MailingStreet | string | Optional | Parameter for Update Contact |
MailingCity | string | Optional | Parameter for Update Contact |
MailingState | string | Optional | Parameter for Update Contact |
MailingPostalCode | string | Optional | Parameter for Update Contact |
MailingCountry | string | Optional | Parameter for Update Contact |
MailingLatitude | string | Optional | Parameter for Update Contact |
MailingLongitude | string | Optional | Parameter for Update Contact |
Input Example
{"do_create":true}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"success":true}}
Update Document
Update a specified document in Salesforce using the provided document ID and file content.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
document_id | string | Required | Unique identifier |
file | array | Required | Parameter for Update Document |
file.file_name | string | Required | Name of the resource |
file.file | string | Required | Parameter for Update Document |
keywords | string | Optional | Parameter for Update Document |
Input Example
{"document_id":"0158c000001l03bAAA","file":[],"keywords":"marketing,sales,update"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
message | string | Response message |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"message":"string"}}
Update Lead
Update a Salesforce lead record using the specified ID. An 'id' parameter is required to identify the lead.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Unique identifier |
do_create | boolean | Optional | Parameter for Update Lead |
ConvertedOpportunityId | string | Optional | Unique identifier |
City | string | Optional | Parameter for Update Lead |
AnnualRevenue | string | Optional | Parameter for Update Lead |
JigsawContactId | string | Optional | Unique identifier |
MasterRecordId | string | Optional | Unique identifier |
FirstName | string | Optional | Name of the resource |
Title | string | Optional | Parameter for Update Lead |
LastName | string | Optional | Name of the resource |
LastReferencedDate | string | Optional | Date value |
LastModifiedById | string | Optional | Unique identifier |
ConvertedAccountId | string | Optional | Unique identifier |
IsUnreadByOwner | string | Optional | Parameter for Update Lead |
State | string | Optional | Parameter for Update Lead |
Attributes_url | string | Optional | URL endpoint for the request |
Latitude | string | Optional | Parameter for Update Lead |
OwnerId | string | Optional | Unique identifier |
string | Optional | Parameter for Update Lead | |
SICCode__c | string | Optional | Parameter for Update Lead |
Website | string | Optional | Parameter for Update Lead |
Fax | string | Optional | Parameter for Update Lead |
Description | string | Optional | Parameter for Update Lead |
NumberOfEmployees | string | Optional | Parameter for Update Lead |
PhotoUrl | string | Optional | URL endpoint for the request |
Input Example
{"do_create":true}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"success":true}}
Update Opportunity
Update a Salesforce Opportunity record using the specified ID as a unique identifier.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Unique identifier |
do_create | boolean | Optional | Parameter for Update Opportunity |
HasOpenActivity | string | Optional | Parameter for Update Opportunity |
FiscalQuarter | string | Optional | Parameter for Update Opportunity |
LastModifiedById | string | Optional | Unique identifier |
Attributes_url | string | Optional | URL endpoint for the request |
CloseDate | string | Optional | Date value |
OrderNumber__c | string | Optional | Parameter for Update Opportunity |
Type | string | Optional | Type of the resource |
Description | string | Optional | Parameter for Update Opportunity |
StageName | string | Optional | Name of the resource |
CampaignId | string | Optional | Unique identifier |
LastModifiedDate | string | Optional | Date value |
ForecastCategoryName | string | Optional | Name of the resource |
CreatedById | string | Optional | Unique identifier |
MainCompetitors__c | string | Optional | Parameter for Update Opportunity |
Attributes_type | string | Optional | Type of the resource |
LastViewedDate | string | Optional | Date value |
IsDeleted | string | Optional | Parameter for Update Opportunity |
AccountId | string | Optional | Unique identifier |
Fiscal | string | Optional | Parameter for Update Opportunity |
Name | string | Optional | Name of the resource |
CurrentGenerators__c | string | Optional | Parameter for Update Opportunity |
FiscalYear | string | Optional | Parameter for Update Opportunity |
IsWon | string | Optional | Parameter for Update Opportunity |
Input Example
{"do_create":true}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"success":true}}
Update Task
Update a specified task in Salesforce using the provided unique identifier (ID).
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Unique identifier |
do_create | boolean | Optional | Parameter for Update Task |
CallDurationInSeconds | string | Optional | Parameter for Update Task |
CallObject | string | Optional | Parameter for Update Task |
LastModifiedById | string | Optional | Unique identifier |
Priority | string | Optional | Parameter for Update Task |
RecurrenceType | string | Optional | Type of the resource |
Attributes_url | string | Optional | URL endpoint for the request |
OwnerId | string | Optional | Unique identifier |
IsRecurrence | string | Optional | Parameter for Update Task |
Status | string | Optional | Status value |
CallDisposition | string | Optional | Parameter for Update Task |
RecurrenceStartDateOnly | string | Optional | Parameter for Update Task |
RecurrenceDayOfWeekMask | string | Optional | Parameter for Update Task |
Description | string | Optional | Parameter for Update Task |
RecurrenceInstance | string | Optional | Parameter for Update Task |
LastModifiedDate | string | Optional | Date value |
WhoId | string | Optional | Unique identifier |
CreatedById | string | Optional | Unique identifier |
ActivityDate | string | Optional | Date value |
Attributes_type | string | Optional | Type of the resource |
IsHighPriority | string | Optional | Parameter for Update Task |
IsDeleted | string | Optional | Parameter for Update Task |
AccountId | string | Optional | Unique identifier |
CallType | string | Optional | Type of the resource |
Input Example
{"do_create":true}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"success":true}}
Salesforce Update Time Sheet Entry
Update a specific Salesforce timesheet entry identified by TimeSheetId, tracking tasks such as travel or asset repair.
Endpoint
- Method: PUT
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Contact ID. |
do_create | boolean | Optional | Do Create. |
CurrencyIsoCode | string | Optional | Available only if the multicurrency feature is enabled. Contains the ISO code for any currency allowed by the organization. Time sheet entries inherit their time sheet's currency code. Updates to a time sheet's currency code aren't reflected in existing time sheet entries' currency code. |
Description | string | Optional | Notes on how the time was spent. For example, "This service took longer than normal because the machine was jammed." |
DurationInMinutes | number | Optional | Minutes recorded on the time sheet entry. |
EndTime | string | Optional | The date and time the activity finished. |
LastReferencedDate | string | Optional | The timestamp when the current user last interacted with this record, directly or indirectly. |
LastViewedDate | string | Optional | The timestamp when the current user last viewed this record or list view. If this value is null, it's possible that the user only accessed this record or list view (LastReferencedDate), but not viewed it. |
LocationTimeZone | string | Optional | Time zone of the location where the activity occurred. This field is available in API version 50.0 and later. |
StartTime | string | Optional | The date and time the activity began. |
Status | string | Optional | The status of the time sheet entry. The picklist includes the following values, which can be customized are New, Submitted, Approved |
Subject | string | Optional | Activity performed; for example, repair, lunch, or travel. |
TimeSheetEntryNumber | string | Optional | An auto-generated number identifying the time sheet entry. |
TimeSheetId | string | Required | The time sheet associated with the time sheet entry. |
Type | string | Optional | The type of work performed. The picklist includes the following values, which can be customized are Direct, Indirect |
WorkOrderId | string | Optional | The work order related to the time sheet entry. Work orders are searchable by their content. |
WorkOrderLineItemId | string | Optional | The work order line item related to the time sheet entry. Work order line items are searchable by their content. |
Input Example
{"do_create":true,"CurrencyIsoCode":"USD","Description":"This service took longer than normal because the machine was jammed.","DurationInMinutes":480,"EndTime":"2024-01-15T17:00:00.000Z","LastReferencedDate":"2024-01-15T17:30:00.000Z","LastViewedDate":"2024-01-15T17:25:00.000Z","LocationTimeZone":"America/New_York","StartTime":"2024-01-15T09:00:00.000Z","Status":"New","Subject":"Activity performed; for example, repair, lunch, or travel","TimeSheetEntryNumber":"TSE-000001","TimeSheetId":"a0X000000000000AAA","Type":"Direct","WorkOrderId":"a0Y000000000000AAA","WorkOrderLineItemId":"a0Z000000000000AAA"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{}}
Update User
Update a Salesforce user's details like email, timezone, language, and profile information using their unique ID.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
id | string | Required | Unique identifier |
UserPreferencesDisableChangeCommentEmail | string | Optional | Parameter for Update User |
Title | string | Optional | Parameter for Update User |
EmailPreferencesAutoBcc | string | Optional | Parameter for Update User |
Department | string | Optional | Parameter for Update User |
MediumPhotoUrl | string | Optional | URL endpoint for the request |
Fax | string | Optional | Parameter for Update User |
UserPreferencesHideEndUserOnboardingAssistantModal | string | Optional | Unique identifier |
UserType | string | Optional | Type of the resource |
UserPreferencesHideLightningMigrationModal | string | Optional | Unique identifier |
UserPreferencesDisableFeedbackEmail | string | Optional | Parameter for Update User |
UserPreferencesPathAssistantCollapsed | string | Optional | Parameter for Update User |
UserPreferencesSortFeedByComment | string | Optional | Parameter for Update User |
UserPreferencesDisableMessageEmail | string | Optional | Response message |
UserPreferencesDisCommentAfterLikeEmail | string | Optional | Parameter for Update User |
UserPreferencesShowPostalCodeToGuestUsers | string | Optional | Parameter for Update User |
Address_state | string | Optional | Parameter for Update User |
CallCenterId | string | Optional | Unique identifier |
EmailEncodingKey | string | Required | Parameter for Update User |
Address_street | string | Optional | Parameter for Update User |
AccountId | string | Optional | Unique identifier |
SmallBannerPhotoUrl | string | Optional | URL endpoint for the request |
JigsawImportLimitOverride | string | Optional | Unique identifier |
EmailPreferencesAutoBccStayInTouch | string | Optional | Parameter for Update User |
Longitude | string | Optional | Parameter for Update User |
Input Example
{"id":"12345678-1234-1234-1234-123456789abc","UserPreferencesDisableChangeCommentEmail":"string","Title":"string","EmailPreferencesAutoBcc":"string","Department":"string","MediumPhotoUrl":"string","Fax":"string","UserPreferencesHideEndUserOnboardingAssistantModal":"string","UserType":"string","UserPreferencesHideLightningMigrationModal":"string","UserPreferencesDisableFeedbackEmail":"string","UserPreferencesPathAssistantCollapsed":"string","UserPreferencesSortFeedByComment":"string","UserPreferencesDisableMessageEmail":"string","UserPreferencesDisCommentAfterLikeEmail":"string","UserPreferencesShowPostalCodeToGuestUsers":"string","Address_state":"string","CallCenterId":"string","EmailEncodingKey":"string","Address_street":"string","AccountId":"string","SmallBannerPhotoUrl":"string","JigsawImportLimitOverride":"string","EmailPreferencesAutoBccStayInTouch":"string","Longitude":"string","UserPreferencesShowStreetAddressToExternalUsers":"string","LastReferencedDate":"string","UserPermissionsMarketingUser":"string","LastViewedDate":"string","UserPermissionsSFContentUser":"string","MobilePhone":"string","TimeZoneSidKey":"string","ForecastEnabled":"string","UserPreferencesShowFaxToGuestUsers":"string","UserPreferencesEnableAutoSubForFeeds":"string","AboutMe":"string","UserPreferencesShowProfilePicToGuestUsers":"string","CommunityNickname":"Example Name","UserPreferencesDisableLikeEmail":"string","StayInTouchSignature":"string","IsActive":"string","UserPreferencesShowPostalCodeToExternalUsers":"string","UserPreferencesHideS1BrowserUI":"string","UserPreferencesDisableLaterCommentEmail":"string","BadgeText":"string","UserPreferencesShowWorkPhoneToExternalUsers":"string","State":"string","UserPreferencesDisableWorkEmail":"string","Latitude":"string","UserPreferencesLightningExperiencePreferred":"string"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
success | boolean | Whether the operation was successful |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"success":true}}
Upload Document
Upload a file to a specified folder in Salesforce using the file content and target folder ID.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
file | array | Required | Parameter for Upload Document |
file.file_name | string | Required | Name of the resource |
file.file | string | Required | Parameter for Upload Document |
folderId | string | Required | Unique identifier |
description | string | Optional | Parameter for Upload Document |
keywords | string | Optional | Parameter for Upload Document |
type | string | Optional | Type of the resource |
Input Example
{"file":[],"folderId":"00l8c000000gbYvAAI","keywords":"marketing,sales,update","type":"pdf"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | string | Unique identifier |
errors | string | Error message if any |
success | boolean | Whether the operation was successful |
fields | array | Output field: fields |
fields.file_name | string | Name of the resource |
fields.file | string | Output field: fields.file |
message | string | Response message |
errorCode | string | Error message if any |
raw_json | object | Output field: raw_json |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"id":"","errors":"","success":true,"fields":[],"message":"","errorCode":"","raw_json":{}}}
Upload Content Version
Insert a new Content Version into Salesforce, requiring both the file and PathOnClient as inputs.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
file | string | Required | Parameter for Upload Content Version |
Title | string | Optional | Parameter for Upload Content Version |
PathOnClient | string | Required | Parameter for Upload Content Version |
ContentLocation | string | Optional | Response content |
Input Example
{"PathOnClient":"Q1 Sales Brochure.pdf","ContentLocation":"Marketing Brochure Q1"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
id | string | Unique identifier |
errors | array | Error message if any |
errors.file_name | string | Name of the resource |
errors.file | string | Error message if any |
success | boolean | Whether the operation was successful |
fields | array | Output field: fields |
fields.file_name | string | Name of the resource |
fields.file | string | Output field: fields.file |
message | string | Response message |
errorCode | string | Error message if any |
raw_json | object | Output field: raw_json |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"id":"","errors":[],"success":true,"fields":[],"message":"","errorCode":"","raw_json":{}}}
Update Attachment
Update a specified attachment in Salesforce using the provided attachment ID.
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
attachment_id | string | Required | Unique identifier |
file | string | Optional | Parameter for Update Attachment |
Input Example
{"attachment_id":"0688c000008G958AAC"}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
message | string | Response message |
Output Example
{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"message":"string"}}
Response Headers
Header | Description | Example |
|---|---|---|
Content-Type | The media type of the resource | application/json |
Date | The date and time at which the message was originated | Thu, 01 Jan 2024 00:00:00 GMT |