createByScreenName

fun Mutes.createByScreenName(screenName: String, vararg options: Option): JsonObjectApiAction<User>

Mutes the user specified in the ID parameter for the authenticating user. Returns the muted user when successful. Returns a string describing the failure condition when unsuccessful. Actions taken in this method are asynchronous. Changes will be eventually consistent.

Twitter API reference

Receiver

Mutes endpoint instance.

Return

JsonObjectApiAction for User model.

Parameters

screenName

The screen name of the potentially muted user. Helpful for disambiguating when a valid screen name is also a user ID.

options

Optional. Custom parameters of this request.