Finish a media item
Promotes the media item from queue to history and clears the now-playing pointer when it points at this item. Fires queue.media.finished. Idempotent - finishing an already-gone item succeeds with media: null. Finishing means “this played” - if it didn’t (your player failed), use release to put it back instead. Requires media:control.
/media/{orderId}/finishAuthorizationBearer token (tp_live_... or tpat_...) · headerrequiredA TipPage API key (tp_live_..., created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (tpat_..., see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.
orderIdstringrequiredThe media item's order id - the only external row reference.
Finished.
successbooleanmediaQueueMediaItem | nullShow propertiesHide properties
order_idstringdonor_namestringmedia_urlstring<uri>media_start_timeintegerStart offset in seconds.
video_titlestring | nullvideo_thumbnailstring<uri> | nullvideo_durationintegerDuration in seconds (0 = unknown).
platformstringrequested_viastringtip | chat | admin | channel_point | ...
is_replaybooleanqueued_atstring<date-time>nullMissing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
The key lacks the required scope (missing_scope).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
required_scopestringRate limit exceeded - check the RateLimit-* headers.
errorstring