Salesforcecrmconnector v1

Returns the list of all custom actions. You can also get basic information for each type of action.
This resource is available in REST API version 32.0 and later.

Parameters

Launches an Autolaunched Flow with the supplied input parameters.

Parameters

Returns a list of global actions and object-specific actions. This resource is available in REST API version 28.0 and later. When working with actions, also refer to SObject Quick Actions.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_quickactions.htm

Parameters

Returns the list of actions that can be statically invoked. You can also get basic information for each type of action.
This resource is available in REST API version 32.0 and later.

Parameters

Decision Matrix Actions

Invoke a decision matrix in a flow with the Decision Matrix Actions. A decision matrix is a user-defined table where you can look up an output based on the inputs you provide.

For example, you can look up a candidate’s eligibility to avail medical insurance in a decision matrix based on the candidate’s age and gender.

These actions are available in API version 55.0 and later.

Supported REST HTTP Methods

URI/services/data/v55.0/actions/custom/runDecisionMatrix/{UniqueName}

Note

The value of UniqueName is the unique identifier of the record, which is sourced from the name of a decision matrix.

FormatsJSONHTTP MethodsPOSTAuthenticationAuthorization: Bearer token

Inputs

Vary depending on the selected decision matrix.

Outputs

Vary depending on the inputs of the selected decision matrix.

Usage

Sample Request

Here’s an example POST request that has the inputs, such as, age and state:

{
   "inputs":[
      {
         "age":"25",
         "state":"NY"
      },
      {
         "age":"25",
         "state":"CA"
      },
      {
         "age":"",
         "state":"WA"
      }
   ]
}

 ```

Sample Response

Here’s an example response that has the premium and tax values based on the inputs provided in the example request.

[
{

  "actionName":"premiumTaxLookup",
  "errors":null,
  "isSuccess":true,
  "outputValues":{
     "premium":2400.0,
     "tax":200.0
  }

},
{

  "actionName":"premiumTaxLookup",
  "errors":null,
  "isSuccess":true,
  "outputValues":{
     "premium":2400.0,
     "tax":200.0
  }

},
{

  "actionName":"premiumTaxLookup",
  "errors":[
     {
        "statusCode":"REQUIRED_FIELD_MISSING",
        "message":"Missing required input parameter: age",
        "fields":[
        ]
     }
  ],
  "isSuccess":false,
  "outputValues":null

}
]

```

Parameters

Expression Set Actions

Invoke an active expression set. An expression set is a user-defined rule that accepts an input and returns the output based on the configured function.

The configured function of an expression set can be a simple decision matrix lookup, a calculation based on a mathematical formula, a condition, or another expression set.

These actions are available in API version 55.0 and later.

Supported REST HTTP Methods

URI/services/data/v55.0/actions/custom/runExpressionSet/{ApiName}

> Note

> The API name of an expression set is unique within your Salesforce instance.

Formats

JSON

HTTP Methods

POST

Authentication

Authorization: Bearer token

Inputs

Vary depending on the selected expression set.

Outputs

Vary depending on the inputs of the selected expression set.

Usage

This section has the sample request and response for invoking an expression set that does the following:

1. Find the tax percentage and the premium corresponding to specific age and salary using a decision matrix lookup.

2. Check the age criterion to calculate the total tax.

3. Calculate the total tax to be paid based on the age group, salary, and the tax percentage.

Sample request

Here’s an example POST request that has the inputs, such as, age and salary:

{
   "inputs":[
      {
         "Age":"25.00",
         "Salary":"50000.00"
      }
   ]
}

 ```

Sample response

Here’s an example response that has the premium and tax values based on the inputs provided in the example request:

[
{

  "actionName":"TaxPremiumES",
  "errors":null,
  "isSuccess":true,
  "outputValues":{
     "TaxPremium__Premium":1000,
     "TaxPremium__Tax":10,
     "TaxToBePaid":1050,
     "condition_output__2":"false",
     "condition_output__1":"true"
  }

}
]

```

Parameters

Parameters

Return frequency metrics about the standard pages within which users switched from Lightning Experience to Salesforce Classic.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_exitbypagemetrics.htm

Parameters

Return details about users who switched between Salesforce Classic and Lightning Experience.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_togglemetrics.htm

Parameters

Return the total number of Lightning Experience and Salesforce Mobile users.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebyapptypemetrics.htm

Parameters

Return details about the custom pages viewed most frequently in Lightning Experience.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebyflexipagemetrics.htm

Parameters

Represents standard pages users viewed most frequently in Lightning Experience.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_usagebypagemetrics.htm

Parameters

Returns detailed information about a list view, including the ID, the columns, and the SOQL query.

Parameters

Returns detailed information about a list view, including the ID, the columns, and the SOQL query.

Parameters

Returns the list of list views for the specified sObject, including the ID and other basic information about each list view. You can also get basic information for a specific list view by ID.

Parameters

Gets the most recently accessed items that were viewed or referenced by the current user. Salesforce stores information about record views in the interface and uses it to generate a list of recently viewed and referenced records, such as in the sidebar and for the auto-complete options in search.

This resource only accesses most recently used item information. If you want to modify the list of recently viewed items, you’ll need to update recently viewed information directly by using a SOQL Query with a FOR VIEW or FOR REFERENCE clause.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_recent_items.htm

Parameters

Parameters

Requests an Open API document for the selected SObject REST API resources.

Parameters

Generate an OpenAPI 3.0 document for the sObjects REST API. This is a Beta feature that requires an activation step before it can be used.

Parameters

Returns a list of all approval processes. Can also be used to submit a particular record if that entity supports an approval process and one has already been defined. Records can be approved and rejected if the current user is an assigned approver. When using a POST request to do bulk approvals, the requests that succeed are committed and the requests that don’t succeed send back an error.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_process_approvals.htm

Parameters

Returns a list of all approval processes. Can also be used to submit a particular record if that entity supports an approval process and one has already been defined. Records can be approved and rejected if the current user is an assigned approver. When using a POST request to do bulk approvals, the requests that succeed are committed and the requests that don’t succeed send back an error.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_process_approvals.htm

Parameters

Returns a list of all active workflow rules. If a rule has actions, the actions will be listed under the rule. Can also be used to trigger all workflow rules that are associated with a specified record. The actions for a rule are only fired if the rule’s criteria is met. When using a POST request, if anything fails, the whole transaction is rolled back.

Cross-object workflow rules cannot be invoked using the REST API.

To get a list of the workflow rules or to trigger one or more workflow rules, the URI is: /vXX.X/process/rules/
To get the rules for a particular object: /vXX.X/process/rules/SObjectName
To get the metadata for a particular rule: /vXX.X/process/rules/SObjectName/workflowRuleId
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_process_rules.htm

Parameters

Gets the list of icons and colors used by themes in the Salesforce application. Theme information is provided for objects in your organization that use icons and colors in the Salesforce UI.

The If-Modified-Since header can be used with this resource, with a date format of EEE, dd MMM yyyy HH:mm:ss z. When this header is used, if the object metadata has not changed since the provided date, a 304 Not Modified status code is returned, with no response body.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_themes.htm

Parameters

Returns a list of items in either the Salesforce app drop-down menu or the Salesforce for Android, iOS, and mobile web navigation menu.

Parameters

Your users can store consent preferences in different locations and possibly inconsistently. You can locate your customers’ preferences for consent across multiple records when using API version 44.0 and later. Tracking consent preferences helps you and your users respect the most restrictive requests.
Consent API aggregates consent settings across the Contact, Contact Point Type Consent, Data Use Purpose, Individual, Lead, Person Account, and User objects when the records have a lookup relationship. The Consent API can't locate records in which the email address field is protected by Platform Encryption.

The API returns consent details based on a single action, like email or track, or—starting with API version 45.0—the multiaction endpoint allows you to request multiple actions in a single API call.

Parameters

Lists information about limits in your org. For each limit, this resource returns the maximum allocation and the remaining allocation based on usage. This resource is available in REST API version 29.0 and later for API users with the View Setup and Configuration permission

Parameters

Work with revenue and quantity schedules for opportunity products. Establish or reestablish a product schedule with multiple installments for an opportunity product. Delete all installments in a schedule.
This resource is available in REST API version 43.0 and later.

In API version 46.0 and later, established and re-established schedules support custom fields, validation rules, and Apex triggers. Deleting all schedules now also fires delete triggers.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_opportunitylineitemschedules.htm

Parameters

Executes the specified SOQL query. Unlike the Query resource, QueryAll will return records that have been deleted because of a merge or delete. QueryAll will also return information about archived Task and Event records. QueryAll is available in API version 29.0 and later.

If the query results are too large, the response contains the first batch of results and a query identifier in the nextRecordsUrl field of the response. The identifier can be used in an additional request to retrieve the next batch. Note that even though nextRecordsUrl has query in the URL, it will still provide remaining results from the initial QueryAll request. The remaining results will include deleted records that matched the initial query.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_queryall.htm

Parameters

Lists information about object record counts in your organization.
This resource is available in REST API version 40.0 and later for API users with the “View Setup and Configuration” permission. The returned record count is approximate, and does not include the following types of records:

Deleted records in the recycle bin.
Archived records.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_record_count.htm

Parameters

Lists available resources for the specified API version, including resource name and URI.

Parameters

f a survey field can be translated or is already translated into a particular language, you can add or change the translated value of the survey field.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/request_survey_translate_add_change.htm

Parameters

Gets the list of icons and colors used by themes in the Salesforce application. Theme information is provided for objects in your organization that use icons and colors in the Salesforce UI.

The If-Modified-Since header can be used with this resource, with a date format of EEE, dd MMM yyyy HH:mm:ss z. When this header is used, if the object metadata has not changed since the provided date, a 304 Not Modified status code is returned, with no response body.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_themes.htm

Parameters

Lists summary information about each Salesforce version currently available, including the version, label, and a link to each version's root.

Parameters

Executes the specified SOQL query.

If the query results are too large, the response contains the first batch of results and a query identifier in the nextRecordsUrl field of the response. The identifier can be used in an additional request to retrieve the next batch.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_query.htm

Parameters

Returns a list of compact layouts for multiple objects. This resource is available in REST API version 31.0 and later.

Parameters

Lists the available objects and their metadata for your organization’s data. In addition, it provides the organization encoding, as well as the maximum batch size permitted in queries.

You can use the If-Modified-Since header with this resource, with the date format EEE, dd MMM yyyy HH:mm:ss z. When using this header, if no available object’s metadata has changed since the provided date, a 304 Not Modified status code is returned with no response body.

Parameters

Returns a list of layouts and descriptions. The list of fields and the layout name are returned.

Parameters

Returns a list of layouts and descriptions. The list of fields and the layout name are returned.

Parameters

Returns a list of layouts and descriptions. The list of fields and the layout name are returned.

Parameters

Lists the available objects and their metadata for your organization’s data. In addition, it provides the organization encoding, as well as the maximum batch size permitted in queries.

You can use the If-Modified-Since header with this resource, with the date format EEE, dd MMM yyyy HH:mm:ss z. When using this header, if no available object’s metadata has changed since the provided date, a 304 Not Modified status code is returned with no response body.

Parameters

Returns a list of approval layouts for a specified object. Specify a particular approval process name to limit the return value to one specific approval layout. This resource is available in REST API version 30.0 and later.

approvalProcessName parameter is optional

Parameters

Describes the individual metadata for the specified object. Can also be used to create a new record for a given object. For example, this can be used to retrieve the metadata for the Account object using the GET method, or create a new Account object using the POST method.

Parameters

Retrieves the specified blob field from an individual record.

Parameters

Returns a list of compact layouts for a specific object. This resource is available in REST API version 29.0 and later.

Parameters

Parameters

Describes the individual metadata for the specified object. Can also be used to create a new record for a given object. For example, this can be used to retrieve the metadata for the Account object using the GET method, or create a new Account object using the POST method.

Parameters

Retrieves the list of individual records that have been deleted within the given timespan for the specified object. SObject Get Deleted is available in API version 29.0 and later.

This resource is commonly used in data replication applications. Note the following considerations:
Deleted records are written to a delete log which this resource accesses. A background process that runs every two hours purges records that have been in an organization's delete log for more than two hours if the number of records is above a certain limit. Starting with the oldest records, the process purges delete log entries until the delete log is back below the limit. This is done to protect Salesforce from performance issues related to massive delete logs
Information on deleted records are returned only if the current session user has access to them.
Results are returned for no more than 15 days previous to the day the call is executed (or earlier if an administrator has purged the Recycle Bin).

Parameters

Retrieves the list of individual records that have been updated (added or changed) within the given timespan for the specified object. SObject Get Updated is available in API version 29.0 and later.

This resource is commonly used in data replication applications. Note the following considerations:
Results are returned for no more than 30 days previous to the day the call is executed.
Your client application can replicate any objects to which it has sufficient permissions. For example, to replicate all data for your organization, your client application must be logged in with “View All Data” access rights to the specified object. Similarly, the objects must be within your sharing rules.
There is a limit of 600,000 IDs returned from this resource. If more than 600,000 IDs would be returned, EXCEEDED_ID_LIMIT is returned. You can correct the error by choosing start and end dates that are closer together.

Parameters

Retrieves information about alternate named layouts for a given object.

Parameters

PlatformAction is a virtual read-only object. It enables you to query for actions displayed in the UI, given a user, a context, device format, and a record ID. Examples include standard and custom buttons, quick actions, and productivity actions.
Returns the description of the PlatformAction.

Parameters

Returns a list of actions and their details. This resource is available in REST API version 28.0 and later. When working with actions, also refer to Quick Actions.

To return a specific object’s actions as well as global actions, use: /vXX.X/sobjects/object/quickActions/
To return a specific action, use /vXX.X/sobjects/object/quickActions/{action name}
To return a specific action’s descriptive detail, use /vXX.X/sobjects/object/quickActions/{action name}/describe/
To return a specific action’s default values, including default field values, use services/data/vXX.X/sobjects/object/quickActions/{action name}/defaultValues/
In API version 28.0, to evaluate the default values for an action, use vXX.X/sobjects/object/quickActions/{action name}/defaultValues/{parent id}
In API version 29.0 and greater, to evaluate the default values for an action, use vXX.X/sobjects/object/quickActions/{action name}/defaultValues/{context id}
This returns the default values specific to the {context id} object.

Parameters

Accesses records by traversing object relationships via friendly URLs. You can retrieve, update, or delete the record associated with the traversed relationship field. If there are multiple related records, you can retrieve the complete set of associated records. This resource is available in REST API version 36.0 and later.

GET, PATCH, DELETE

Parameters

Retrieves the specified image data from a specific rich text area field in a given record.
contentReferenceId The reference ID that uniquely identifies an image within a rich text area field.
You can obtain the reference by retrieving information for the object. The description will show the contents of the rich text area field

Parameters

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.

Parameters

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.

Parameters

Accesses records based on the specified object ID. Retrieves, updates, or deletes records. This resource can also be used to retrieve field values. Use the GET method to retrieve records or fields, the DELETE method to delete records, and the PATCH method to update records.

Parameters

Creates new records or updates existing records (upserts records) based on the value of a specified external ID field.

If the specified value doesn't exist, a new record is created.
If a record does exist with that value, the field values specified in the request body are updated.
If the value is not unique, the REST API returns a 300 response with the list of matching records.

HEAD, GET, PATCH, DELETE, POST

Parameters

Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later.

Parameters

Returns a list of suggested Salesforce Knowledge articles for a case, work order, or work order line item.

Parameters

Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later.

Parameters

Returns a list of available service resources (appointment candidates) based on work type group and service territories.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/requests_ls_getappointmentcandidates.htm

Parameters

Returns a list of available appointment time slots for a resource based on given work type group and territories.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/requests_ls_getappointmentslots.htm

Parameters

Return frequency metrics about the standard pages within which users switched from Lightning Experience to Salesforce Classic.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_lightning_exitbypagemetrics.htm

Parameters

Executes a simple RESTful search using parameters instead of a SOSL clause. Indicate parameters in a URL in the GET method. Or, use POST for more complex JSON searches.

Parameters

Gets the current user’s most relevant items. Relevant items include records for objects in the user’s global search scope and also most recently used (MRU) objects.
Relevant items include up to 50 of the most recently viewed or updated records for each object in the user’s global search scope.
Note
The user’s global search scope includes the objects the user interacted with most in the last 30 days, including objects the user pinned from the search results page in the Salesforce Classic.

Then, the resource finds more recent records for each most recently used (MRU) object until the maximum number of records, which is 2,000, is returned.
This resource only accesses the relevant item information. Modifying the list of relevant items is not currently supported
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_relevant_items.htm

Parameters

Executes the specified SOSL search. The search string must be URL-encoded.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search.htm

Parameters

Returns search result layout information for the objects in the query string. For each object, this call returns the list of fields displayed on the search results page as columns, the number of rows displayed on the first page, and the label used on the search results page.
This call supports bulk fetch for up to 100 objects in a query.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_layouts.htm

Parameters

Returns an ordered list of objects in the default global search scope of a logged-in user. Global search keeps track of which objects the user interacts with and how often and arranges the search results accordingly. Objects used most frequently appear at the top of the list.
The returned list reflects the object order in the user’s default search scope, including any pinned objects on the user’s search results page. This call is useful if you want to implement a custom search results page using the optimized global search scope. The search string must be URL-encoded.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_scope_order.htm

Parameters

Returns a list of suggested searches based on the user’s query string text matching searches that other users have performed in Salesforce Knowledge. Provides a way to improve search effectiveness, before the user performs a search.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_suggest_queries.htm

Parameters

Returns a list of suggested records whose names match the user’s search string. The suggestions resource provides autocomplete results and instant results for users to navigate directly to likely relevant records, before performing a full search.

https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_search_suggest_records.htm

Parameters

Get all online article fields, accessible to the user.

Parameters

Get a page of online articles for the given language and category through either search or query.

Parameters

Get data category details and the child categories by a given category.

Parameters

Returns the list of list views for the specified sObject, including the ID and other basic information about each list view. You can also get basic information for a specific list view by ID.

Parameters

Retrieves the values for your Embedded Service deployment configuration, including the branding colors, font, and site URL.

You must be logged in to the account that owns the EmbeddedServiceConfigDeveloperName you are querying.

Parameters

Returns the existing Knowledge language settings, including the default knowledge language and a list of supported Knowledge language information.
https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_knowledge_retrieve_language.htm

Parameters