Skip to content
TipPage Docs
Esc
↑↓navigate↵open⌘Jpreview

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.

POST/media/{orderId}/release
Authorization
AuthorizationBearer token (tp_live_... or tpat_...) · headerrequired

A 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.

Path parameters
orderIdstringrequired

The media item's order id - the only external row reference.

Responses
200

Released (released: false when there was no claim to drop).

successboolean
releasedboolean

Whether a now-playing claim was actually dropped.

mediaQueueMediaItem | null
Show properties
One of:
QueueMediaItem
order_idstring
donor_namestring
media_urlstring<uri>
media_start_timeinteger

Start offset in seconds.

video_titlestring | null
video_thumbnailstring<uri> | null
video_durationinteger

Duration in seconds (0 = unknown).

platformstring
requested_viastring

tip | chat | admin | channel_point | ...

is_replayboolean
queued_atstring<date-time>
null
null
401

Missing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

403

The key lacks the required scope (missing_scope).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

required_scopestring
429

Rate limit exceeded - check the RateLimit-* headers.

errorstring
Try it
Server
Authorization
Parameters
Request
curl -X POST 'https://api.tippage.com/v1/media/string/release' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "success": true,
  "released": true,
  "media": {
    "order_id": "string",
    "donor_name": "string",
    "media_url": "http://example.com",
    "media_start_time": 0,
    "video_title": "string",
    "video_thumbnail": "http://example.com",
    "video_duration": 0,
    "platform": "youtube",
    "requested_via": "string",
    "is_replay": true,
    "queued_at": "2019-08-24T14:15:22Z"
  }
}