Create a Text Quiz

Changed on
post/text-quizzes/

Request

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

Request body

program_idstring required

The id of the program to create the Text Quiz for

questionstring required

The question or prompt asked by the Text Quiz

interactive_untilstring date

The UTC time that the widget will stop accepting interactions

playback_time_msinteger

Video playback time in milliseconds

custom_datastring
sponsor_idsstring[]

Links the sponsors with this Text Quiz. Note that only valid sponsor_ids will be linked to a Text Quiz.

Response

201

client_idstring
created_atstring
custom_dataunknown
engagement_countinteger
engagement_percentstring
idstring
impression_countinteger
impression_urlstring
interaction_urlstring
interactive_untilstring
kindstring
program_date_timeunknown
program_idstring
publish_delaystring
published_atstring
questionstring
rewards_urlunknown
schedule_urlstring
scheduled_atstring
statusstring
subscribe_channelstring
timeoutstring
translatable_fieldsstring[]
translationsobject
unique_impression_countinteger
playback_time_msunknown
urlstring
widget_interactions_url_templatestring

Example response

{
  "choices": [
    {
      "answer_url": "https://blastrt-prod-us-east-1.livelikecdn.com/api/v1/widget-interactions/text-quiz/cfa2139a-2430-44e4-9e2f-a17a46ab6466/choices/cdf0ad02-b51d-4646-b0ca-2f0361f2c6ce/answers/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbmNyeXB0ZWQiOiJnQUFBQUFCaFM0a3VpR3JYajZYczRMUU1pOWhIeFVEejU2dUpSVVdGcGZKV19ja0UxbThlWmppVUF2UXEyOC1kak9BY2VMN0xFMWZiYzBPUzFXajNjSnhTckE3YnBIR0U2Zz09IiwiaXNzIjoiYmxhc3QiLCJpYXQiOjE2MzIzNDAyNzB9.qB5-XPKREBTy_4rzQSUYoznKVVW73XwoXwQy5ZF5bpk/",
      "description": "Seattle Seahawks",
      "id": "cdf0ad02-b51d-4646-b0ca-2f0361f2c6ce",
      "translatable_fields": [
        "description"
      ]
    }
  ],
  "client_id": "UJQCf1jWIhKmQpOYdhe6H56Uc4Xp50b1zdVaOowO",
  "created_at": "2021-09-22T19:42:13.569848Z",
  "created_by": {
    "id": "1bf5b2ff-d82b-4400-b4eb-38a8d7bf538c"
  },
  "engagement_percent": "0.000",
  "id": "cfa2139a-2430-44e4-9e2f-a17a46ab6466",
  "impression_count": 1,
  "impression_url": "https://blastrt-prod-us-east-1.livelikecdn.com/api/v1/widget-impressions/text-quiz/cfa2139a-2430-44e4-9e2f-a17a46ab6466/",
  "interaction_url": "https://cf-blast.livelikecdn.com/api/v1/text-quizzes/cfa2139a-2430-44e4-9e2f-a17a46ab6466/interactions/",
  "interactive_until": "2022-01-18T18:53:56.510Z",
  "kind": "text-quiz",
  "program_id": "075a1d11-1489-4dd0-b7c4-a7642f5f517f",
  "publish_delay": "P0DT00H00M00S",
  "published_at": "2021-09-22T19:42:13.813239Z",
  "question": "Which team has won a Super Bowl more recently?",
  "schedule_url": "https://cf-blast.livelikecdn.com/api/v1/text-quizzes/cfa2139a-2430-44e4-9e2f-a17a46ab6466/schedule/",
  "scheduled_at": "2021-09-22T19:42:13.721870Z",
  "status": "published",
  "subscribe_channel": "program.widget.cfa2139a-2430-44e4-9e2f-a17a46ab6466",
  "timeout": "P0DT00H00M30S",
  "translatable_fields": [
    "question"
  ],
  "unique_impression_count": 1,
  "url": "https://cf-blast.livelikecdn.com/api/v1/text-quizzes/cfa2139a-2430-44e4-9e2f-a17a46ab6466/",
  "widget_interactions_url_template": "https://cf-blast.livelikecdn.com/api/v1/profiles/{profile_id}/widget-interactions/?text_quiz_id=cfa2139a-2430-44e4-9e2f-a17a46ab6466"
}

Changes