penicillin/blue.starry.penicillin.endpoints.account/updateProfileBackgroundImage

updateProfileBackgroundImage

fun Account.updateProfileBackgroundImage(    mediaId: Long,     tile: Boolean? = null,     includeEntities: Boolean? = null,     skipStatus: Boolean? = null,     vararg options: Option): JsonObjectApiAction<User>
Content copied to clipboard

Updates the authenticating user's profile background image. This method can also be used to enable or disable the profile background image. Although each parameter is marked as optional, at least one of image or media_id must be provided when making this request. Learn more about the deprecation of this endpoint via our forum post.

Twitter API reference

Receiver

Account endpoint instance.

Return

JsonObjectApiAction for User model.

Parameters

tile

Optional. Whether or not to tile the background image. If set to true , t or 1 the background image will be displayed tiled. The image will not be tiled otherwise.

includeEntities

Optional. The entities node will not be included when set to false.

skipStatus

Optional. When set to either true, t or 1 statuses will not be included in the returned user object.

mediaId

Specify the media to use as the background image. More information on upload of media is available here.

options

Optional. Custom parameters of this request.