Update a user
Changed onUpdate a user
You can update information about a user using this API. In addition to changing a user's nickname or profile image, you can issue a new access token for the user. The new access token replaces the previous one as the necessary token for authentication.
You can also deactivate or reactivate a user using this API request. If the leave_all_when_deactivated is set to true, a user leaves all joined group channels and becomes deactivated.
Note: Issuing session tokens through the /users/{user_id} endpoint is now deprecated and it's replaced with <code>/users/{user_id}/token</code> endpoint for greater efficiency. For those who are currently using the old endpoint, you can start issuing tokens using the new endpoint.
https://sendbird.com/docs/chat/platform-api/v3/user/managing-users/update-a-user#1-update-a-user
Request
- Base URLhttps://api-APP_ID.sendbird.com
- Authnone declared
Path parameters
(Required)
Headers
Request body
Response
Successful response
Example response
{
"metadata": "{}",
"is_active": true,
"preferred_languages": [
"preferred_languages",
"preferred_languages"
],
"require_auth_for_profile_image": true,
"unread_channel_count": 6,
"discovery_keys": [
"discovery_keys",
"discovery_keys"
],
"profile_url": "profile_url",
"is_created": true,
"created_at": 9,
"has_ever_logged_in": true,
"locale": "locale",
"unread_message_count": 8,
"access_token": "access_token",
"is_shadow_blocked": true,
"user_id": "user_id",
"nickname": "nickname",
"phone_number": "phone_number",
"is_online": true,
"state": "",
"is_hide_me_from_friends": true,
"last_seen_at": 9
}Changes
- info
the request property
became nullable - info
the request property
became nullable - info
the request property
became nullable - info
the request property
became nullable
- info
- warning
deleted the
headerrequest parameterApi-Token - warning
removed the request property
- warning
removed the request property
- warning
removed the request property
- info
api operation id
updateUserByIdremoved and replaced withupdateAUser - info
added the new optional
headerrequest parameterapi-token
- warning