LIlivelike

Create a Text Ask widget

Ask your audience. Collect their replies, and feature the best ones.

post/

Request

  • Base URL
    https://cf-blast.livelikecdn.com/api/v1/text-asks
  • URL
    https://cf-blast.livelikecdn.com/api/v1/text-asks/
  • Auth
    OAuth 2

Request body

program_idstring required

The Program ID

titlestring required

The title of the Ask widget

promptstring required

The question or "prompt" to ask the user.

confirmation_messagestring

The message displayed to the user when they make their submission

interactive_untilstring date

The UTC time that the widget will stop accepting interactions

playback_time_msinteger

Video playback time in milliseconds

sponsor_idsstring[]

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

Response

201

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

Example response

{
  "client_id": "UJQCf1jWIhKmQpOYdhe6H56Uc4Xp50b1zdVaOowO",
  "confirmation_message": "Thanks for your submission!  Tune in at 8 PM to see if your question was selected!",
  "created_at": "2021-09-22T19:46:29.217285Z",
  "created_by": {
    "id": "1bf5b2ff-d82b-4400-b4eb-38a8d7bf538c"
  },
  "engagement_percent": "0.000",
  "id": "a91d99db-436d-414d-abd9-292683ba182e",
  "impression_url": "https://blastrt-prod-us-east-1.livelikecdn.com/api/v1/widget-impressions/text-ask/a91d99db-436d-414d-abd9-292683ba182e/",
  "interaction_url": "https://cf-blast.livelikecdn.com/api/v1/text-asks/a91d99db-436d-414d-abd9-292683ba182e/interactions/",
  "interactive_until": "2022-01-18T18:53:56.510Z",
  "kind": "text-ask",
  "program_id": "075a1d11-1489-4dd0-b7c4-a7642f5f517f",
  "prompt": "Ask Russell Wilson your questions and see if yours is selected!",
  "publish_delay": "P0DT00H00M00S",
  "published_at": "2021-09-22T19:46:29.594342Z",
  "reply_url": "https://blastrt-prod-us-east-1.livelikecdn.com/api/v1/text-asks/a91d99db-436d-414d-abd9-292683ba182e/replies/",
  "schedule_url": "https://cf-blast.livelikecdn.com/api/v1/text-asks/a91d99db-436d-414d-abd9-292683ba182e/schedule/",
  "scheduled_at": "2021-09-22T19:46:29.430763Z",
  "status": "published",
  "subscribe_channel": "program.widget.a91d99db-436d-414d-abd9-292683ba182e",
  "timeout": "P0DT00H00M30S",
  "title": "AMA with Russell Wilson!",
  "translatable_fields": [
    "title"
  ],
  "url": "https://cf-blast.livelikecdn.com/api/v1/text-asks/a91d99db-436d-414d-abd9-292683ba182e/",
  "widget_interactions_url_template": "https://cf-blast.livelikecdn.com/api/v1/profiles/{profile_id}/widget-interactions/?text_ask_id=a91d99db-436d-414d-abd9-292683ba182e"
}

Changes

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