Skip to content

Commit

Permalink
Merge pull request #7661 from braze-inc/bd-3243
Browse files Browse the repository at this point in the history
BD-3243 Update POST users merge to now include phone numbers
  • Loading branch information
lydia-xie authored Jul 10, 2024
2 parents 5e76e26 + 8a66495 commit eb723e0
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions _docs/_api/endpoints/user_data/post_users_merge.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Authorization: Bearer YOUR_REST_API_KEY

| Parameter | Required | Data Type | Description |
|---|---|---|---|
| `merge_updates` | Required | Array | An object array. Each object should contain an `identifier_to_merge` object and an `identifier_to_keep` object, which should each reference a user either by `external_id`, `user_alias` or `email`. |
| `merge_updates` | Required | Array | An object array. Each object should contain an `identifier_to_merge` object and an `identifier_to_keep` object, which should each reference a user either by `external_id`, `user_alias`, `phone_number`, or `email`. |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4}

### Merge behavior
Expand Down Expand Up @@ -99,9 +99,9 @@ When merging users, using the `/users/merge` endpoint works the same way as usin

These merged fields will update "for X events in Y days" filters. For purchase events, these filters include "number of purchases in Y days" and "money spent in last Y days".

### Merging users by email
### Merging users by email or phone number

If an `email` is specified as an identifier, an additional `prioritization` value is required in the identifier. The `prioritization` should be an array specifying which user to merge if there are multiple users found. `prioritization` is an ordered array, meaning if more than one user matches from a prioritization, then merging will not occur.
If an `email` or `phone_number` is specified as an identifier, an additional `prioritization` value is required in the identifier. The `prioritization` should be an array specifying which user to merge if there are multiple users found. `prioritization` is an ordered array, meaning if more than one user matches from a prioritization, then merging will not occur.

The allowed values for the array are: `identified`, `unidentified`, `most_recently_updated`. `most_recently_updated` refers to prioritizing the most recently updated user.

Expand Down

0 comments on commit eb723e0

Please sign in to comment.