Update user alias endpoint documentation #4751
Conversation
shihanxiong
requested review from
josh-mccrowell-braze,
KellieHawks and
lydia-xie
|
We require contributors to sign our Contributor License Agreement, and we don't have you on file. In order for us to review and merge your code, please fill out the information here. To re-call the cla-bot, comment |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
shihanxiong
requested review from
raghavnarain3,
Vector919,
davehensley and
dekel1207
|
We require contributors to sign our Contributor License Agreement, and we don't have you on file. In order for us to review and merge your code, please fill out the information here. To re-call the cla-bot, comment |
|
@shihanxiong When you get the chance, can you sign our contributor license agreement? Thanks! |
|
@cla-bot check |
|
The cla-bot has been summoned, and re-checked this pull request! |
_includes/rate_limits.md
Outdated
| <!---/users/alias/update--> | ||
|
|
||
| {% elsif include.endpoint == "users alias update" %} | ||
| For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 20,000 requests per minute to this endpoint. This rate limit is shared with the `/users/delete`, `/users/identify`, and `/users/merge` endpoints, as documented in [API rate limits]({{site.baseurl}}/api/api_limits/). | ||
|
|
There was a problem hiding this comment.
We need to update all of these to include all of the endpoints, so in this section we need to add /users/alias/new, and in the ones above we need to add /users/alias/update. Or maybe we need to change how we list these, since the list is starting to get a little long...
There was a problem hiding this comment.
That makes sense, will update these to match. Not sure what's the best way to render a list and exclude the current endpoint in markdown. Maybe in the future we should just put a link that points to a list of endpoints that have 20000 rate limit?
| - name: "POST: Update a User Alias" | ||
| link: /docs/api/endpoints/user_data/post_users_alias_update/ | ||
| fa_icon: fas fa-user-edit |
There was a problem hiding this comment.
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.
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?
|
@shihanxiong I think we want to document that edge case we discussed in standup |
shihanxiong
force-pushed
the
CO-1128-users-alias-update-documentation
branch
from
d55680c to
19882e6
Compare
Added a banner |
_includes/rate_limits.md
Outdated
| For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 20,000 requests per minute to this endpoint. This rate limit is shared with the `/users/delete`, `/users/alias/new`, and `/users/identify` endpoints, as documented in [API rate limits]({{site.baseurl}}/api/api_limits/). | ||
| For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 20,000 requests per minute to this endpoint. This rate limit is shared with the `/users/delete`, `/users/alias/new`, `/users/identify`, and `users/alias/new` endpoints, as documented in [API rate limits]({{site.baseurl}}/api/api_limits/). |
There was a problem hiding this comment.
/users/alias/new is listed twice, should be /users/alias/update. Also, for consistency these should probably all begin with /.
There was a problem hiding this comment.
Thx @davehensley for the catch
lydia-xie
changed the title
Pull Request/Issue Resolution
Description of Change:
Closes #ISSUE_NUMBER_HERE
Is this change associated with a Braze feature/product release?
✔️ Pull Request Checklist
assets>js>broken_redirect_list.js⭐ Helpful Wiki Shortcuts
❗ ATTN: For PR Reviewers
❗ ATTN: Internal Reviewing Chart
Work at Braze and not sure who to tag for review?
Before tagging @timothy-kim or @KellieHawks for a general review, reference the following chart to see if a specific product vertical/reviewer applies to your pull request.
Quality Infrastructure
Platform Infrastructure
Datalake
SDKs
Internal Tools
Product Partnerships
SMS
Customer Lifecycle, Identity and Permissions
Intelligence
User Targeting
IAM
Channels
FIX
Core Objects
Core Messaging
Messaging and Automation
Email (Composition and Infrastructure)