Configuring Salesforce Cloud Target Header Properties

Enter the Salesforce Cloud target header values for your integration.

Topics

What You Can Do from the Salesforce Cloud Target Headers Page

You can configure the target header properties for Salesforce Cloud.

What You See on the Salesforce Target Headers Page

The following table describes the key information on the Salesforce Cloud target Headers page.

The headers available for configuration are based on the operation you selected on the target Operations page. There are two types of headers:

  • Request headers are sent with the request message to the Salesforce application.

  • Response headers are received with the response message sent from the Salesforce application.

For more information about these header properties, visit www.salesforce.com and specify the specific name of the property in the search utility.
Element Description

AllOrNoneHeader (request header)

Specifies the transactional behavior for Salesforce application operations. If you set AllorNone to true, the call to the Salesforce application is committed only if it completes without any errors. Otherwise, it is rolled back. The default behavior is to commit partial records without any error.

AllowFieldTruncationHeader (request header)
Specifies the truncation behavior for the following fields (each are string data types):

  • anyType

  • email

  • picklist

  • encryptedstring

  • textarea

  • mulitpicklist

  • phone

  • string

Set allowFieldTruncation to one of the following values:

  • True: If you enter a value of 25 characters in a field of 20 characters, the first 20 records are inserted into the field and the transaction is successful.

  • False: If you enter a value of 25 characters in a field of 20 characters, an error is thrown and the transaction does not commit.

AssignmentRuleHeader (request header)

Specifies the assignment rule to use when creating or updating an account, case, or lead. The assignment rule can be active or inactive. The ID is retrieved by querying the AssignmentRule object. If the ID is specified, you do not need to specify the useDefaultRule value.

  • assignmentRuleId: The ID of the assignment rule to use. The ID is not validated by the Salesforce Cloud application, whether or not it exists. Validation occurs during runtime.

  • useDefaultRule: If set to true, the default (active) assignment rule is used. If set to false, the default (active) assignment rule is not used.

EmailHeader (request header)
Specifies whether or not to send a notification email. You can set the following properties:

  • triggerAutoResponseEmail

    • true: Triggers automatic response rules for leads and cases.

    • false: Automatic response rules for leads and cases are not triggered.

  • triggerOtherEmail

    • true: The email is triggered outside the organization.

    • false: The email is not triggered outside the organization.

  • triggerUserEmail

    • true: The email is triggered and sent to users in the organization. This email is triggered by a number of events such as adding comments to a case or updating a task.

    • false: The email is not triggered and sent to users in the organization.

DebuggingHeader (request header)
Specify the debugging log level. The following log levels are supported:

  • NONE (least verbose)

  • DEBUGONLY

  • DB

  • PROFILING

  • CALLOUT

  • DETAIL (most verbose)

MruHeader (request header)
The Salesforce application shows the most recently used (MRU) items. In API version 7.0 or later, the list is not updated by itself. Use MruHeader to update the list. Using this header can negatively impact performance. Set updateMru to one of the following values:

  • true: The list of MRU items is updated in the Salesforce application.

  • false: The list of most recently used items is not updated in the Salesforce application.

PackageVersionHeader (request header)

Specifies the package version for any installed package. The package version identifies the components in a package. The package version follows the format majorNumber.minorNumber.patchNumber (for example, 3.4.5, where 3 refers to majorNumber, 4 refers to minorNumber, and 5 refers to patchNumber) .

QueryOptions (request header)

Specifies the batch size for queries. The default value is 500, the minimum value is 200, and the maximum value is 2000.

DebuggingInfo (response header)

This information is only returned if the debugLevel request header is sent with the request payload to the Salesforce application.

LimitInfoHeader (response header)
Provides information about the limitations of API calls on a per-day basis for the organization.

  • current:

    The number of calls already used in the organization.

  • Limit:

    The organization’s limit for the specified limit type.

  • Type:

    The limit information type specified in the header API REQUESTS (contains limit information about API calls for the organization).