Allmine API
Live Streams

Set live stream reminder for current user

**Production uyarisi:** Bu endpoint veri degistirir veya operasyon tetikleyebilir. API Playground icinde Production server seciliyse gercek production verisi etkilenir; test icin Development server kullanin. Creates or updates a single reminder for current user on given stream. Null/0 minute means notify when stream actually starts.

POST
/api/v1/live-stream/{id}/reminder

Production uyarisi: Bu endpoint veri degistirir veya operasyon tetikleyebilir. API Playground icinde Production server seciliyse gercek production verisi etkilenir; test icin Development server kullanin.

Creates or updates a single reminder for current user on given stream. Null/0 minute means notify when stream actually starts.

Authorization

JWT-auth
AuthorizationBearer <token>

Paste the JWT access token without the Bearer prefix.

In: header

Path Parameters

id*string

Live stream ID

Request Body

application/json

Reminder settings payload

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/live-stream/string/reminder" \  -H "Content-Type: application/json" \  -d '{    "minute": 15  }'
{
  "isSuccess": true,
  "statusCode": 200,
  "data": {
    "streamId": "65f000000000000000000011",
    "minute": 15,
    "mode": "ON_START",
    "scheduledFor": "2026-03-05T18:45:00.000Z",
    "status": "ARMED_ON_START"
  },
  "errors": [],
  "timestamp": "2026-05-22T16:11:27.034Z"
}
{
  "isSuccess": false,
  "statusCode": 400,
  "data": null,
  "errors": [
    "Validation failed"
  ],
  "timestamp": "2026-01-15T10:30:00.000Z"
}
{
  "isSuccess": false,
  "statusCode": 401,
  "data": null,
  "errors": [
    "Authentication required"
  ],
  "timestamp": "2026-01-15T10:30:00.000Z"
}
{
  "isSuccess": false,
  "statusCode": 403,
  "data": null,
  "errors": [
    "Insufficient permissions"
  ],
  "timestamp": "2026-01-15T10:30:00.000Z"
}
{
  "isSuccess": false,
  "statusCode": 404,
  "data": null,
  "errors": [
    "Resource not found"
  ],
  "timestamp": "2026-01-15T10:30:00.000Z"
}
{
  "isSuccess": false,
  "statusCode": 409,
  "data": null,
  "errors": [
    "Resource already exists or cannot be changed in its current state"
  ],
  "timestamp": "2026-01-15T10:30:00.000Z"
}

Cancel Live Stream POST

**Production uyarisi:** Bu endpoint veri degistirir veya operasyon tetikleyebilir. API Playground icinde Production server seciliyse gercek production verisi etkilenir; test icin Development server kullanin. Cancel Live Stream. Creates or executes live stream through POST /api/v1/live-stream/{id}/cancel.

Cancel live stream reminder for current user DELETE

**Production uyarisi:** Bu endpoint veri degistirir veya operasyon tetikleyebilir. API Playground icinde Production server seciliyse gercek production verisi etkilenir; test icin Development server kullanin. Cancels current user reminder for given stream. Operation is idempotent.