Salesforce

the salesforce connector enables seamless integration between salesforce crm services and the swimlane turbine platform, facilitating automated data exchange and action execution salesforce is a leading customer relationship management (crm) platform that enables businesses to connect with customers, streamline processes, and improve profitability the salesforce turbine connector allows users to seamlessly integrate salesforce's powerful crm capabilities with swimlane turbine's security automation workflows by leveraging this connector, security teams can automate data synchronization, manage customer information, and enhance incident response directly within the swimlane platform, ensuring a unified and efficient security operation prerequisites before you can use the salesforce connector for turbine, ensure you have the following salesforce credentials for authentication using these parameters username the email address used to log into your salesforce account password the password associated with your salesforce username instance the unique identifier for your salesforce instance, typically in the format of ' https //instance salesforce com ' 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 https //developer salesforce com/ 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 https //login salesforce com or https //test salesforce com 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 retrieves 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 creates 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 initiates 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 creates 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" "user\@example com","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 creates 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 email 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" "user\@example com","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 creates 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 creates 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 creates a new user in salesforce with essential details like email, username, and profile id all required fields must be 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 deletes 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 deletes 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 removes 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 removes 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 removes 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 retrieves 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 retrieves 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 retrieves 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 retrieves the 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 retrieves 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 retrieves 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 retrieves 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 retrieves a salesforce user's details using their unique identifier (id) an 'input id' is required 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 posts a new comment to a salesforce case, requiring 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 executes 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, requiring 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 performs 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 updates a salesforce account with specified id, allowing for modification of 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 updates 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 updates 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 updates 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 updates 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 updates 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 email 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 updates 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 updates 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 updates 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 updates a salesforce user's details such as 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 uploads a file to a specified folder in salesforce, requiring both the file content and the 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 updates 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