Introduction
This API updates the nickname and roles of a specified external user by username (Member No.).
Note: The member number cannot be modified through this API.
API Version History
API Version | Update Date | Description |
v6 | November 12, 2026 | Added the External User Update API. |
API Calling
API Information
Item | Description |
Request URL | |
Request Method | POST |
Request Rate | 20 requests/second |
Request Body Format | JSON |
Request Parameters
Parameter | Required | Type | Description |
| Yes | String | Member No. of the external user to be updated. |
| No | String | Updated nickname of the external user. |
| No | Number[] | Updated list of role IDs assigned to the external user. |
Sample Request
{ "username": "jodoo",
"name": "Alex",
"roles": [4]
}API Response
Response Parameters
Parameter | Type | Description |
| Object | Updated external user information. |
| String | Member No. of the external user. |
| String | Nickname of the external user. |
| Number[] | List of role IDs assigned to the external user. |
| Number | Member type. |
| Number | Member status. |
Sample Response
{ "user": {
"username": "jodoo",
"name": "Alex",
"roles": [4],
"type": 1,
"status": 1
}
}