Release a claimed media item back to the queue
The undo of start, for when playback didn’t go to plan - the player errored, the video wouldn’t load, your process is shutting down mid-item. Drops the now-playing claim WITHOUT finishing: the item stays in the queue at its position, and it can be claimed again. Fires queue.media.released. Only drops a claim that actually points at this order id - never a different item’s claim - and releasing something you don’t hold is a safe no-op (released: false). If the item DID play, use finish instead so it lands in history. Requires media:control.
/media/{orderId}/releaseAuthorizationBearer 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.
Released (released: false when there was no claim to drop).
successbooleanreleasedbooleanWhether a now-playing claim was actually dropped.
mediaQueueMediaItem | 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