IdentityResolutionSettings

Retrieve Identity Resolution Settings.

These settings determine how Customer Memory will use identifiers for searching, merging, and resolving profiles.

Some settings can only take on their default values and are not yet available to change, but coming soon.

get/v1/ControlPlane/Stores/{storeId}/IdentityResolutionSettings

Response

Identity resolution settings retrieved successfully

matchingRulesstring[] required

Priority list of identifiers to locate profiles to apply new data to, or for determining if two existing profiles should merge.

Individual rules are evaluated with OR logic between them, meaning that satisfying any single rule will trigger a match. Each rule is a single identifier type; compound rules are not supported.

Rules are evaluated in order.

  • If no rule matches against existing profiles, a new profile will be created.
  • If a rule matches to a single existing profile, the profile will be updated.
  • If a rule matches to multiple existing profiles, those existing profiles will be merged.
versioninteger required

The current version number of the Identity Resolution Settings. Incremented on each successful update.

Example response

{
  "identifierConfigs": [
    {
      "idType": "email",
      "limitPolicy": "fifo",
      "enforceUnique": true,
      "normalization": "email"
    }
  ],
  "matchingRules": [
    "email",
    "whatsapp",
    "phone"
  ],
  "version": 3
}

Changes

Changed in 1 of the 8 revisions of this API.52

  • v1b0ed05460bbf52See the full diff
    • the code response property's max was increased from 99999.00 to 999999.00 for the response status 400

      response-property-max-increased

    • the code response property's max was increased from 99999.00 to 999999.00 for the response status 404

      response-property-max-increased

    • the code response property's max was increased from 99999.00 to 999999.00 for the response status 429

      response-property-max-increased

    • the code response property's max was increased from 99999.00 to 999999.00 for the response status 500

      response-property-max-increased

    • the code response property's max was increased from 99999.00 to 999999.00 for the response status 503

      response-property-max-increased

    • the response property identifierConfigs became required for the status 200

      response-property-became-required

    • the response property matchingRules became required for the status 200

      response-property-became-required

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 8 revisions, 1 has no diff computed.