Skip to contents

Authentication

Function to authenticate to your Salesforce Org.

sf_auth() stable
Log in to Salesforce

Query/Search Functions

Functions to query and search records.

sf_query() stable
Perform SOQL Query
sf_search() stable
Perform SOSL Search

CRUD Functions

Functions to perform create, retrieve, update, and delete (CRUD) operations on records.

sf_create() stable
Create Records
sf_retrieve() stable
Retrieve Records By Id
sf_update() stable
Update Records
sf_upsert() stable
Upsert Records
sf_delete() stable
Delete Records
sf_undelete() experimental
Undelete Records
sf_get_deleted() stable
Get Deleted Records from a Timeframe
sf_get_updated() stable
Get Updated Records from a Timeframe

Attachment Functions

Convenience functions to work with attachments.

sf_create_attachment() experimental
Create Attachments
sf_download_attachment() stable
Download an Attachment
sf_update_attachment() experimental
Update Attachments
sf_delete_attachment() experimental
Delete Attachments

Bulk API Functions

Convenience functions to perform async CRUD and query operations.

sf_run_bulk_query() sf_query_bulk() stable
Run bulk query
sf_run_bulk_operation() sf_bulk_operation() stable
Run Bulk Operation

Report Functions

Functions to create, retrieve, update, delete and query reports and their data.

sf_run_report() experimental
Get a report's data in tabular format
sf_list_reports() experimental
List reports
sf_describe_report() experimental
Describe a report
sf_create_report() experimental
Create a report
sf_copy_report() experimental
Copy a report
sf_update_report() experimental
Update a report
sf_execute_report() experimental
Execute a report
sf_delete_report() experimental
Delete a report
sf_list_report_instances() experimental
List report instances
sf_get_report_instance_results() experimental
Get report instance results
sf_delete_report_instance() experimental
Delete a report instance
sf_list_report_types() experimental
List report types
sf_describe_report_type() experimental
Describe a report type
sf_list_report_fields() experimental
Get a list of report fields
sf_list_report_filter_operators() experimental
List report filter operators

Dashboard Functions

Functions to create, retrieve, update, delete and query dashboards and their data.

sf_list_dashboards() experimental
List dashboards
sf_describe_dashboard() experimental
Describe a dashboard
sf_describe_dashboard_components() experimental
Describe dashboard components
sf_get_dashboard_status() experimental
Get the status of a dashboard
sf_get_dashboard_results() experimental
Get the results of an existing dashboard
sf_get_dashboard_data() experimental
Get dashboard data in a tabular format
sf_filter_dashboard_operators_list() experimental
List dashboard filter operators
sf_filter_dashboard_options_analysis() experimental
Get an analysis of the filter options for a dashboard
sf_refresh_dashboard() experimental
Refresh an existing dashboard
sf_copy_dashboard() experimental
Copy a dashboard
sf_update_dashboard() experimental
Update a dashboard
sf_set_dashboard_sticky_filter() experimental
Set a sticky dashboard filter
sf_delete_dashboard() experimental
Delete a dashboard

Metadata Functions

Functions to create, retrieve, update, and delete metadata.

sf_create_metadata() experimental
Create Object or Field Metadata in Salesforce
sf_update_metadata() experimental
Update Object or Field Metadata in Salesforce
sf_upsert_metadata() experimental
Upsert Object or Field Metadata in Salesforce
sf_delete_metadata() experimental
Delete Object or Field Metadata in Salesforce
sf_rename_metadata() experimental
Rename Metadata Elements in Salesforce
sf_read_metadata() experimental
Read Object or Field Metadata from Salesforce
sf_list_metadata() experimental
List All Objects of a Certain Metadata Type in Salesforce
sf_retrieve_metadata() experimental
Make A Request to Retrieve the Metadata
sf_describe_metadata() experimental
Describe the Metadata in an Organization
sf_describe_objects() stable
SObject Basic Information
sf_describe_object_fields() stable
Describe Object Fields

Salesforce Org Utility Functions

Functions to perform basic org-wide routines.

sf_merge() experimental
Merge Records
sf_convert_lead() experimental
Convert Leads
sf_find_duplicates() experimental
Find Duplicate Records
sf_find_duplicates_by_id() experimental
Find Duplicate Records By Id
sf_empty_recycle_bin() experimental
Empty Recycle Bin
sf_get_all_jobs_bulk()
Get All Bulk API Jobs
sf_get_all_query_jobs_bulk()
Get All Bulk API Query Jobs
sf_list_rest_api_versions() stable
List REST API Versions
sf_list_resources() stable
List the Resources for an API
sf_list_api_limits() stable
List the Limits for an API
sf_list_objects() stable
List Organization Objects and their Metadata
sf_user_info() stable
Return Current User Info
sf_server_timestamp() stable
Salesforce Server Timestamp
sf_set_password() experimental
Set User Password
sf_reset_password() experimental
Reset User Password
sf_control()
Auxiliary for Controlling Calls to Salesforce APIs

Backward Compatibility with RForcecom

Functions that mimic {RForcecom} to ease code transitions between {salesforcer} and {RForcecom}.

rforcecom.login() soft-deprecated
The salesforcer backwards compatible version of RForcecom::rforcecom.login
rforcecom.getServerTimestamp() soft-deprecated
The salesforcer backwards compatible version of RForcecom::rforcecom.getServerTimestamp
rforcecom.getObjectDescription() soft-deprecated
The salesforcer backwards compatible version of RForcecom::rforcecom.getObjectDescription
rforcecom.create() soft-deprecated
The salesforcer backwards compatible version of RForcecom::rforcecom.create
rforcecom.retrieve() soft-deprecated
The salesforcer backwards compatible version of RForcecom::rforcecom.retrieve
rforcecom.update() soft-deprecated
The salesforcer backwards compatible version of RForcecom::rforcecom.update
rforcecom.delete() soft-deprecated
The salesforcer backwards compatible version of RForcecom::rforcecom.delete
rforcecom.upsert() soft-deprecated
The salesforcer backwards compatible version of RForcecom::rforcecom.upsert
rforcecom.search() soft-deprecated
The salesforcer backwards compatible version of RForcecom::rforcecom.search
rforcecom.query() soft-deprecated
The salesforcer backwards compatible version of RForcecom::rforcecom.query
rforcecom.bulkQuery() soft-deprecated
The salesforcer backwards compatible version of RForcecom::rforcecom.bulkQuery