-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update user alias endpoint documentation #4751
Merged
Merged
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
a9929fe
docs: first pass of users alias update documentation
shihanxiong d55680c
Minor edits
lydia-xie c0789e2
docs: first pass of users alias update documentation
shihanxiong 19882e6
docs: addressed comments
shihanxiong b2a5658
docs: added notes banner for users merge
shihanxiong 3e2bbb7
Edits and fixes
lydia-xie e574102
Update _docs/_api/endpoints/user_data/post_users_merge.md
lydia-xie File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| --- | ||
| nav_title: "POST: Update User Alias" | ||
| article_title: "POST: Update User Alias" | ||
| search_tag: Endpoint | ||
| page_order: 2 | ||
| layout: api_page | ||
| page_type: reference | ||
| description: "This article outlines details about the Update User Aliases Braze endpoint." | ||
| --- | ||
| {% api %} | ||
| # Update user alias | ||
| {% apimethod post %} | ||
| /users/alias/update | ||
| {% endapimethod %} | ||
|
|
||
| Use this endpoint to update existing user aliases. | ||
|
|
||
| {% alert note %} | ||
| You can update up to 50 user aliases per request. | ||
| {% endalert %} | ||
|
|
||
| Updating a user alias requires `alias_label`, `old_alias_name`, and `new_alias_name` to be included in the update user alias object. If there is no user alias associated with the `alias_label` and `old_alias_name`, no alias will be updated. If the given `alias_label` and `old_alias_name` is found, then the `old_alias_name` will be updated to the `new_alias_name`. | ||
|
|
||
| {% alert note %} | ||
| This endpoint does not guarantee the sequence of `alias_updates` objects being updated. | ||
| {% endalert %} | ||
|
|
||
| ## Rate limit | ||
|
|
||
| {% multi_lang_include rate_limits.md endpoint='users alias update' %} | ||
|
|
||
| ## Request body | ||
|
|
||
| ``` | ||
| Content-Type: application/json | ||
| Authorization: Bearer YOUR-REST-API-KEY | ||
| ``` | ||
|
|
||
| ```json | ||
| { | ||
| "alias_updates" : (required, array of update user alias object) | ||
| } | ||
| ``` | ||
|
|
||
| ### Request parameters | ||
|
|
||
| | Parameter | Required | Data Type | Description | | ||
| | --------- | --------- | --------- | ----------- | | ||
| | `alias_updates` | Required | Array of update user alias objects | See [user alias object]({{site.baseurl}}/api/objects_filters/user_alias_object/).<br><br> For more information on `old_alias_name`, `new_alias_name`, and `alias_label`, refer to [User aliases]({{site.baseurl}}/user_guide/data_and_analytics/user_data_collection/user_profile_lifecycle/#user-aliases). | | ||
| {: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4} | ||
|
|
||
| ### Endpoint request body with update user alias object specification | ||
|
|
||
| ```json | ||
| { | ||
| "alias_label" : (required, string), | ||
| "old_alias_name" : (required, string), | ||
| "new_alias_name" : (required, string) | ||
| } | ||
| ``` | ||
|
|
||
| ## Example request | ||
| ``` | ||
| curl --location --request POST 'https://rest.iad-01.braze.com/users/alias/update' \ | ||
| --header 'Content-Type: application/json' \ | ||
| --header 'Authorization: Bearer YOUR-API-KEY-HERE' \ | ||
| --data-raw '{ | ||
| "alias_updates" :[ | ||
| { | ||
| "alias_label": "example_alias_label", | ||
| "old_alias_name" : "example_old_alias_name", | ||
| "new_alias_name" : "example_new_alias_name" | ||
| } | ||
| ] | ||
| }' | ||
| ``` | ||
|
|
||
| {% endapi %} | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like these URLs all changed at some point (they used to live under
/docs/developer_guide/rest_api/user_data/). It appears that there are redirects in place from the old URLs to these new ones, but maybe we should go into platform and update the URLs there? At least we should check to make sure the new one we just added will get redirected properly.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yea from the look of it I think the links in braze-doc are correct. We should update the URLs in platform. I can make a card for it if that sounds okay to you. Currently the links point to the page that lists all the users data endpoints so it's kinda okay I think?