Create Program

Creating a new program inside an app

post/

Request

Base URL
https://cf-blast.livelikecdn.com/api/v1/programs
URL
https://cf-blast.livelikecdn.com/api/v1/programs/
Auth
none required

Request body

client_idstring required

The unique identifier of the app to create the program in

titlestring required

The human-readable title of the program

scheduled_atstring date required

The date and time the program is scheduled to begin in ISO format

sponsor_idsstring[]

List of sponsors to link with the program

custom_idstring

Associate a Custom ID from another system with this Program

stream_urlstring

Optional url of a video stream

Response

201

urlstring

widgets_urlstring

leaderboard_urlstring

rank_urlstring

client_idstring

application_urlstring

idstring

titlestring

created_atstring

scheduled_atstring

started_atstring

stopped_atunknown

custom_idunknown

queue_order_urlstring

delete_widgets_urlstring

widgets_enabledboolean

chat_enabledboolean

subscribe_channelstring

widget_countinteger

sendbird_channelstring

stream_urlstring

statusstring

sync_sessions_urlstring

sync_channelunknown

start_program_urlstring

stop_program_urlstring

active_sessions_statistics_urlstring

statistics_channelstring

current_active_session_countinteger

sticker_packs_urlstring

reaction_packs_urlstring

update_sticker_packs_urlstring

rewards_typestring

report_urlstring

ban_urlstring

moderation_urlstring

banned_chat_users_urlstring

oembed_urlstring

sponsors_urlstring

Example response

{
  "url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/",
  "widgets_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/widgets/",
  "leaderboard_url": "https://cf-blast.livelikecdn.com/api/v1/leaders/?client_id=pilot&program_id=f1938a34-2611-4cff-9043-ad6b3dd2f6fd",
  "rank_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/rank/",
  "client_id": "pilot",
  "application_url": "https://cf-blast.livelikecdn.com/api/v1/applications/pilot/",
  "id": "f1938a34-2611-4cff-9043-ad6b3dd2f6fd",
  "title": "HCI Usability Test",
  "created_at": "2019-02-12T12:27:22.323196Z",
  "scheduled_at": "2019-04-10T22:13:00Z",
  "started_at": "2019-04-08T18:31:43Z",
  "queue_order_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/queue-order/",
  "delete_widgets_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/delete-widgets/",
  "widgets_enabled": true,
  "chat_enabled": true,
  "subscribe_channel": "program_f1938a34_2611_4cff_9043_ad6b3dd2f6fd",
  "widget_count": 220,
  "sendbird_channel": "program_f1938a34_2611_4cff_9043_ad6b3dd2f6fd",
  "stream_url": "https://cf-streams.livelikecdn.com/live/colorbars-angle1/index.m3u8",
  "status": "live",
  "sync_sessions_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/sync-sessions/",
  "start_program_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/start/",
  "stop_program_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/stop/",
  "active_sessions_statistics_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/statistics/active-sessions/",
  "statistics_channel": "statistics_f1938a34_2611_4cff_9043_ad6b3dd2f6fd",
  "sticker_packs_url": "https://cf-blast.livelikecdn.com/api/v1/sticker-packs/?program_id=f1938a34-2611-4cff-9043-ad6b3dd2f6fd",
  "reaction_packs_url": "https://cf-blast.livelikecdn.com/api/v1/reaction-packs/?program_id=f1938a34-2611-4cff-9043-ad6b3dd2f6fd",
  "update_sticker_packs_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/sticker-packs/",
  "analytics_properties": {
    "Program ID": "f1938a34-2611-4cff-9043-ad6b3dd2f6fd",
    "Program Title": "HCI Usability Test"
  },
  "rewards_type": "badges",
  "report_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/report/",
  "ban_url": "https://cf-blast.livelikecdn.com/api/v1/programs/f1938a34-2611-4cff-9043-ad6b3dd2f6fd/ban/",
  "moderation_url": "https://cf-blast.livelikecdn.com/api/v1/reported-chat-messages/?program_id=f1938a34-2611-4cff-9043-ad6b3dd2f6fd",
  "banned_chat_users_url": "https://cf-blast.livelikecdn.com/api/v1/banned-chat-users/?program_id=f1938a34-2611-4cff-9043-ad6b3dd2f6fd",
  "oembed_url": "https://cf-blast.livelikecdn.com/api/v1/oembed-meta/",
  "sponsors_url": "https://cf-blast-storage-dig.livelikecdn.com/sponsors/0d73952f-bd52-49bb-a2b3-f522cd5692fe/sponsors.json",
  "chat_rooms": [
    {
      "id": "4e45cc19-0c8d-4f7d-9bdb-842da03c0d21",
      "url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/4e45cc19-0c8d-4f7d-9bdb-842da03c0d21/",
      "client_id": "pilot",
      "created_at": "2019-11-21T20:12:02.730797Z",
      "channels": {
        "chat": {
          "sendbird": "chat_4e45cc19_0c8d_4f7d_9bdb_842da03c0d21",
          "pubnub": "chat_4e45cc19_0c8d_4f7d_9bdb_842da03c0d21"
        },
        "reactions": {
          "pubnub": "reactions_4e45cc19_0c8d_4f7d_9bdb_842da03c0d21"
        }
      }
    }
  ],
  "default_chat_room": {
    "id": "4e45cc19-0c8d-4f7d-9bdb-842da03c0d21",
    "url": "https://cf-blast.livelikecdn.com/api/v1/chat-rooms/4e45cc19-0c8d-4f7d-9bdb-842da03c0d21/",
    "client_id": "pilot",
    "created_at": "2019-11-21T20:12:02.730797Z",
    "channels": {
      "chat": {
        "sendbird": "chat_4e45cc19_0c8d_4f7d_9bdb_842da03c0d21",
        "pubnub": "chat_4e45cc19_0c8d_4f7d_9bdb_842da03c0d21"
      },
      "reactions": {
        "pubnub": "reactions_4e45cc19_0c8d_4f7d_9bdb_842da03c0d21"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.