Skip to content

Commit

Permalink
Minor edits
Browse files Browse the repository at this point in the history
  • Loading branch information
lydia-xie committed Feb 1, 2023
1 parent a9929fe commit d55680c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion _docs/_api/endpoints/user_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ guide_featured_list:
fa_icon: fas fa-user
- name: "POST: Update a User Alias"
link: /docs/api/endpoints/user_data/post_users_alias_update/
fa_icon: fas fa-user
fa_icon: fas fa-user-edit
- name: "POST: Delete User Data"
link: /docs/api/endpoints/user_data/post_user_delete/
fa_icon: fas fa-user-minus
Expand Down
6 changes: 3 additions & 3 deletions _docs/_api/endpoints/user_data/post_users_alias_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ search_tag: Endpoint
page_order: 4
layout: api_page
page_type: reference
description: "This article outlines details about the update User Aliases Braze endpoint."
description: "This article outlines details about the Update User Aliases Braze endpoint."

---
{% api %}
Expand All @@ -20,7 +20,7 @@ Use this endpoint to update existing user aliases.
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`.
Updating a user alias requires `alias_label`, `old_alias_name`, and `new_alias_name` to be included in the upda te 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`.

## Rate limit

Expand All @@ -43,7 +43,7 @@ Authorization: Bearer YOUR-REST-API-KEY

| 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`, check out our [User Aliases]({{site.baseurl}}/user_guide/data_and_analytics/user_data_collection/user_profile_lifecycle/#user-aliases) documentation.|
| `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
Expand Down

0 comments on commit d55680c

Please sign in to comment.