Skip to content

Commit

Permalink
Merge pull request #1593 from vtexdocs/fix-alternate-keys-info
Browse files Browse the repository at this point in the history
remove custom alternate keys information
  • Loading branch information
julia-rabello authored Nov 22, 2024
2 parents 77e1382 + 32fa807 commit 7438e06
Showing 1 changed file with 0 additions and 22 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ Using the `PUT` [Create or delete custom fields](https://developers.vtex.com/doc

- [Adding custom fields](#adding-custom-fields)
- [Defining PII and sensitive custom fields](#defining-pii-and-sensitive-custom-fields)
- [Configuring Unique Alternate Keys](#configuring-unique-alternate-keys)
- [Configuring TTL](#configuring-ttl)
- [Deleting custom fields](#deleting-custom-fields)
- [Restrictions](#restrictions)
Expand Down Expand Up @@ -77,27 +76,6 @@ Set the `sensitive` and/or `pii` properties as `true` inside the JSON Schema pro

```

### Configuring Unique Alternate Keys

Unique Alternate Keys are properties that must be used to identify the profile, such as email, phone number, and document number. When defined, these properties can be used as the `key` parameter to retrieve and manage information from the Profile System API.

This property must be structured as a string or as an array. The `v-unique-alternate-keys` array accepts up to three items, meaning three different keys. **Once created, alternate keys cannot be removed**.

**Example**

```json
`v-unique-alternate-keys`: [
{
"name": "email",
"fields": ["email"]
},
{
"name": "phone",
"fields": ["phone"]
}
]
```

### Configuring TTL

The TTL (Time To Live) property is a value expressed in days used to schedule the deletion of the document in the future. When this time expires, the document is automatically deleted.
Expand Down

0 comments on commit 7438e06

Please sign in to comment.