IdentityResolutionSettings

Retrieve Identity Resolution Settings.

Changed on

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

Request

  • Base URL
    https://memory.twilio.com
  • URL
    https://memory.twilio.com/v1/ControlPlane/Stores/{storeId}/IdentityResolutionSettings
  • Auth
    HTTP basic

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • info

      the response property became required for the status

    • info

      the response property became required for the status