REST API Developer Guide

Introduction to REST API
About REST API
Release Notes
Supported Editions and Required Permissions
REST Resources and Requests
REST API Architecture
Authorization Through External Client Apps or Connected Apps and OAuth 2.0
Headers
Assignment Rule Header
Call Options Header
Compression Headers
Conditional Request Headers
Duplicate Rule Header
Limit Info Header
MRU Header
Package Version Header
Query Options Header
Warning Header
Send REST Requests with cURL
Valid Date and DateTime Formats
Status Codes and Error Responses
API End-of-Life Policy
Quick Start
Examples
Generating an OpenAPI 3.0 Document for sObjects REST API (Beta)
Reference
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Duplicate Rule Header

Configure options for duplicate rules. Salesforce uses duplicate rules to see if the record that is being created, updated, or upserted is a duplicate of an existing record. Duplicate rules are part of Duplicate Management.
This header is available in API version 52.0 and later.

Header Field Name and Values

The default value for all fields is false.

Field name: allowSave

Field values

  • true—allow the user to acknowledge the alert and save the duplicate record. Applicable if an alert is enabled for the action.
  • false—don't allow the user to acknowledge the alert or save the duplicate record. Applicable if an alert is enabled for the action.

Field name: includeRecordDetails

Field values

  • true—return all fields in the duplicate record.
  • false—return the duplicate record ID, but not the fields.

Field name: runAsCurrentUser

Field values

  • true—when the duplicate rule is run, use the current user's sharing rules.
  • false—when the duplicate rule is run, use the system sharing rules, not the current user's sharing rules.

Allow the user to acknowledge the alert and save the duplicate record. Indicate that the duplicate field's records are returned, and that the current user's sharing rules are enforced. These duplicate management configuration options are now applied when records are created, updated, and upserted.

1Sforce-Duplicate-Rule-Header: allowSave=true; includeRecordDetails=true; runAsCurrentUser=true