--- schema_version: "1" id: 3569ffb880e25bf587eeff88075ac5e779d13a5615929e0ddfafee956bdb5d3f title: Check for Duplicate Records collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/uiapi/ui_api_resources_predupe_create.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_predupe_create.htm source_site: developer.salesforce.com content_type: documentation content_hash: ebb17cb6d3253141334478a38b2dcc4565703d76ea5a1b0002aa97ee958e0594 description: Before updating or creating a record, you can check whether a duplicate record exists. Use the response to learn whether to block or allow the action, and whether to warn the user. --- # Check for Duplicate Records Before updating or creating a record, you can check whether a duplicate record exists. Use the response to learn whether to block or allow the action, and whether to warn the user. ![Tip](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/images/icon_note_tip.png) #### Tip To learn more about when to check for duplicate records, see [Get Duplicate Management Configuration for a Specified Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_duplicates_get.htm "Learn whether duplicate management is configured for the specified object. If duplicate management is configured, learn about the object's duplicate rules and matching rules. Use the information in the response to know when to check for duplicate records."). Resource /ui-api/predupe Available Version 50.0 HTTP Method POST Example Use the following request to check whether a duplicate record for the movie "Aliens" exists. ui-api/predupe{ "apiName" : "Movie\_\_c", "fields" : {"Name": "Aliens", "Year\_\_c": "1986" } Request Body
Name Type Description Required or Optional Available Version
allowSaveOnDuplicate Boolean Specifies whether to save a duplicate record (true), or not (false). The default value is false.

Don’t specify this property when checking for duplicate records.

 Optional 43.0
apiName String To create a record, specify the API name of an Object from which to create the record. To update a record, use null or don’t pass this property. To check for duplicate records, specify the API name of the object for which you’re performing the duplicate check. Required to create a record.

Required to check for duplicate records.

 41.0
fields Map<String, Object> Map of field names to field values.

Format data types according to these rules:

  • Address—JSON String. Addresses are compound fields and must be broken up into their constituent fields. See the previous example.
  • Boolean—JSON Boolean, true or false
  • Currency—JSON Number (for example, 67.54)
  • Date—JSON string (for example, 2020-04-20)
  • DateTime—JSON string in ISO 8601 format (for example, 2012-02-18T06:40:41.000Z)
  • Double—JSON Number
  • Email—JSON String (for example, joe@smith.com)
  • EncryptedString—JSON String
  • Int—JSON Number
  • Location—JSON String. Location fields are compound fields and must be broken up into their constituent fields.
  • MultiPicklist—JSON String (for example, Dog;Cat;Fish).
  • Percent—JSON Number
  • Phone—JSON String
  • Picklist—JSON String
  • Reference—JSON String
  • String—JSON String
  • TextArea—JSON String
  • Time—JSON String in format HH:MM:SS
  • Url—JSON String

To specify the main record type, either don’t specify the RecordTypeId field, or set it to null.

 Required 41.0
Response Body [Duplicates](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_duplicates.htm "The results of a check for duplicate records.") #### See Also - [Get Duplicate Management Configuration for a Specified Object](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_duplicates_get.htm "Learn whether duplicate management is configured for the specified object. If duplicate management is configured, learn about the object's duplicate rules and matching rules. Use the information in the response to know when to check for duplicate records.")