| user_id |
str |
Specifies the unique ID of the user to update. |
|
| nickname |
str |
Specifies the user's nickname. The length is limited to 80 characters. |
[optional] |
| profile_url |
str |
Specifies the URL of the user's profile image. The length is limited to 2,048 characters.<br /><br /> The domain filter filters out the request if the value of this property matches the filter's domain set. |
[optional] |
| profile_file |
file_type |
Uploads the file of the user's profile image. An acceptable image is limited to `JPG` (.jpg), `JPEG` (.jpeg), or `PNG` (.png) file of up to 25 MB. |
[optional] |
| issue_access_token |
bool |
Determines whether to revoke the existing access token and create a new one for the user. If true, an opaque string token is issued and provided upon creation, which should be passed whenever the user logs in. If false, an access token is not required when the user logs in. (Default: false) |
[optional] |
| issue_session_token |
bool |
Determines whether to add a new session token for the user. If true, an opaque string token is issued and provided upon creation, which should be passed whenever the user logs in. If false, a session token is not required when the user logs in. (Default: false) |
[optional] |
| session_token_expires_at |
int |
Specifies the time for the issued session token to expire in Unix milliseconds format. The length should be 13. If not specified and the issue_session_token property above is true, the value of this property is set to the sum of the current timestamp and 604800000 by default, which indicates that the token will be valid for the next 7 days starting from the current timestamp. |
[optional] |
| is_active |
bool |
Determines whether to activate or deactivate the user within the application. |
[optional] |
| last_seen_at |
int |
Specifies the time when the user goes offline, to indicate when they were last online, in Unix milliseconds format. |
[optional] |
| discovery_keys |
[str] |
Specifies an array of unique keys of the user which is provided to Sendbird server for discovering friends. By using the keys, the server can identify and match the user with other users. |
[optional] |
| preferred_languages |
[str] |
Specifies an array of one or more language codes to translate notification messages to preferred languages. Up to 4 languages can be set for the user. If messages are sent in one of the preferred languages, notification messages won't be translated. If messages are sent in a language other than the preferred languages, notification messages will be translated into the first language in the array. In addition, the messages translated into other preferred languages will be provided in the `sendbird` property of a notification message payload. |
[optional] |
| leave_all_when_deactivated |
bool |
Determines whether the user leaves all joined group channels upon deactivation. Note that this value is true by default. Use in conjunction with the is_active property above. |
[optional] |
| any string name |
bool, date, datetime, dict, float, int, list, str, none_type |
any string name can be used but the value must be the correct type |
[optional] |