v3

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-08-014669239.7 KB

Identifiers

Modify Profile Identifier

Asynchronously replace one of the stored values associated with the identifier type on a profile. newValue is normalized according to the configured identifier settings.

If the new identifier already exists and points to another profile, merge processes may apply.

patch/v1/Stores/{storeId}/Profiles/{profileId}/Identifiers/{idType}

Request body

idTypestring required

The identifier type to update (e.g., email, phone).

oldValuestring required

Existing stored value to replace.

newValuestring required

New value to store for the identifier. Normalization rules from the corresponding identifier settings apply.

Example request

{
  "idType": "phone",
  "oldValue": "+13175556789",
  "newValue": "+13175556798"
}

Response

Identifier update accepted.

messagestring required

Example response

{
  "message": "Identifier update accepted."
}