penicillin/blue.starry.penicillin.endpoints.statuses/unretweet

unretweet

fun Statuses.unretweet(    id: Long,     trimUser: Boolean? = null,     tweetMode: TweetMode? = null,     vararg options: Option): JsonObjectApiAction<Status>
Content copied to clipboard

Untweets a retweeted status. Returns the original Tweet with Retweet details embedded.

Usage Notes:

  • This method is subject to update limits. A HTTP 429 will be returned if this limit has been hit.

  • The untweeted retweet status ID must be authored by the user backing the authentication token.

  • An application must have write privileges to POST. A HTTP 401 will be returned for read-only applications.

  • When passing a source status ID instead of the retweet status ID a HTTP 200 response will be returned with the same Tweet object but no action.

Twitter API reference

Receiver

Statuses endpoint instance.

Return

JsonObjectApiAction for Status model.

Parameters

id

The numerical ID of the desired status.

trimUser

When set to either true, t or 1, each Tweet returned in a timeline will include a user object including only the status authors numerical ID. Omit this parameter to receive the complete user object.

options

Optional. Custom parameters of this request.