Users - Update

Description

Updates the description of a user specified by a Bearer token.

Method Definition

@RequestLine("PUT /users?description={description}")
@Headers("Authorization: Bearer {token}")
HystrixCommand<UserList> updateUser(
    @Param("token") String authToken,
    @Param("description") String description
);

Required Parameters

Name	Type	Description
authToken	string	User Auth Token with the user:edit scope
description	string	The string to update the channel’s description to. The description is limited to a maximum of 300 characters.

Optional Parameters

None

Code-Snippets

update the description of a user

Java

twitchClient.getHelix().updateUser(accessToken, "Twitch4J IntegrationTest User").execute();

Kotlin

twitchClient.helix.updateUser(accessToken, "Twitch4J IntegrationTest User").execute()

Groovy

twitchClient.helix.updateUser(accessToken, "Twitch4J IntegrationTest User").execute()