end

suspend fun end(broadcasterId: String, predictionId: String, status: PredictionEndStatus, winningOutcomeId: String? = null): Prediction

Twitch API: End Prediction

Locks, resolves, or cancels a Channel Points Prediction.

Return

the ended prediction.

Parameters

broadcasterId

the ID of the broadcaster that's running the prediction. This ID must match the user ID in the user access token.

predictionId

the ID of the prediction to update.

status

the status to set the prediction to. Possible case-sensitive values are: RESOLVED, CANCELED, LOCKED. The broadcaster can update an active prediction to LOCKED, RESOLVED, or CANCELED; and update a locked prediction to RESOLVED or CANCELED.

winningOutcomeId

the ID of the winning outcome. You must set this parameter if you set status to RESOLVED.