Alias
Add, remove, replace, or rename entries in an alias list.
Manage users and teams global permission is required to call this API.
- Add new users in the additions array.
- Remove existing users in the removals array. Attempts to remove a user that does not exist in the Alias list will have no effect.
- Replace the entire Alias list with the entries array.
- You can also update the alias' name and description. For example, given an Alias with members userA and userB:
- additions: [userC] results in [userA, userB, userC]
- removals: [userB] results in [userA]
- entries: [userC, user D] results in [userC, userD]
post/aliases/{aid}
Path parameters
aidstring required
Response
default response