Updating a user role
The steps below explain how to update the role for a user.
Note: To learn about the types and functionalities of each role, see user role concepts.
| Step | Name | Endpoint | Details |
|---|---|---|---|
| List users | /v3/users/list | List users for a specific TMC or for a company. Use this endpoint to obtain the userId of the user whose role needs to be updated. Request body requires: The tmcId or the companyId. Additionally, the userStatusFilter lets you filter the ACTIVE, INACTIVE, or ALL users. Response will contain: List of users matching the filter condition, along with each user’s userId, name, and all available information (e.g., user’s personal and business info). Other APIs will use: userId of the user whose role needs to be updated. | |
| Update user role | /v2/users/{userId}/roles | Update the user’s role. URL path requires: userId from step 1. Request body requires: The new roleType to be assigned to the user. If the user is assigned the TRAVEL_ARRANGER role then the roles > metadata field must be populated in the request. |