openapi: 3.2.0
info:
  title: engagement-suite Widget Messages API
  version: '1'
servers:
- url: https://cf-blast.livelikecdn.com/api/v1
security:
- {}
tags:
- name: Widget Messages
paths:
  /{chat_room_id}/widget-messages/:
    post:
      responses:
        '200':
          description: ''
        '201':
          content:
            application/json:
              schema:
                type: object
                properties: {}
              examples:
                Created:
                  summary: Created
                  value:
                    id: dfc86c35-9d49-452c-b484-caec765e454e
                    chat_room_id: 7973b48b-cfb3-4f57-9bb5-552b39cdc247
                    sender_id: e52943b1-0e39-4413-9f36-8bae3bd7d51a
                    sender_nickname: Jolly Baboon
                    sender_image_url: null
                    badge_image_url: null
                    sender_profile_url: http://localhost:8888/api/v1/profiles/e52943b1-0e39-4413-9f36-8bae3bd7d51a/
                    created_at: '2026-09-03T05:04:11.536032+00:00'
                    message_event: widget-message-created
                    widget_kind: text-poll
                    widget_id: 17df95e7-9265-49d2-8269-27fc197e0d86
                    widget_data:
                      id: 17df95e7-9265-49d2-8269-27fc197e0d86
                      pubnub_enabled: true
                      url: http://testserver/api/v1/text-polls/17df95e7-9265-49d2-8269-27fc197e0d86/
                      kind: text-poll
                      program_id: 8d1885c6-1635-4d41-8904-76f3e86eeb49
                      program_name: test app 1 program 1
                      client_id: FVQI5U57tfCyDV99YjhF3ExdlpiObg5JASvy81Mu
                      created_at: '2026-07-17T16:03:59.591Z'
                      published_at: '2026-07-17T16:03:59.745Z'
                      scheduled_at: '2026-07-17T16:03:59.685Z'
                      interactive_until: null
                      question: '1'
                      timeout: P0DT00H00M15S
                      options:
                      - id: 51be5577-e8f3-49d0-9aa7-ec3afe8adc81
                        description: '2'
                        vote_count: 0
                        vote_url: http://testserver/api/v1/text-poll-options/51be5577-e8f3-49d0-9aa7-ec3afe8adc81/votes/
                        translations: {}
                        translatable_fields:
                        - description
                        filtered_description: null
                        content_filter: []
                        localized_data: {}
                      - id: 8cfbefaf-6615-4a32-9333-638b88e32e4d
                        description: '3'
                        vote_count: 0
                        vote_url: http://testserver/api/v1/text-poll-options/8cfbefaf-6615-4a32-9333-638b88e32e4d/votes/
                        translations: {}
                        translatable_fields:
                        - description
                        filtered_description: null
                        content_filter: []
                        localized_data: {}
                      subscribe_channel: program.widget.17df95e7-9265-49d2-8269-27fc197e0d86
                      program_date_time: null
                      publish_delay: P0DT00H00M00S
                      interaction_url: http://testserver/api/v1/text-polls/17df95e7-9265-49d2-8269-27fc197e0d86/interactions/
                      impression_url: http://testserver/api/v1/text-polls/17df95e7-9265-49d2-8269-27fc197e0d86/impressions/
                      impression_count: 0
                      unique_impression_count: 0
                      engagement_count: 0
                      engagement_percent: '0.000'
                      status: published
                      created_by:
                        id: e52943b1-0e39-4413-9f36-8bae3bd7d51a
                        name: Jolly Baboon
                        image_url: null
                        custom_id: test-custom-id
                      schedule_url: http://testserver/api/v1/text-polls/17df95e7-9265-49d2-8269-27fc197e0d86/schedule/
                      rewards_url: null
                      translations: {}
                      translatable_fields:
                      - question
                      reactions: []
                      custom_data: null
                      widget_interactions_url_template: http://testserver/api/v1/profiles/{profile_id}/widget-interactions/?text_poll_id=17df95e7-9265-49d2-8269-27fc197e0d86
                      sponsors: []
                      earnable_rewards:
                      - reward_item_id: 194d4d03-b7c0-4b72-bf7f-1974c92a4709
                        reward_item_name: Test Points
                        reward_action_key: poll-voted
                        reward_item_amount: 5
                      widget_attributes: []
                      playback_time_ms: null
                      report_counts:
                        total: 0
                        pending: 0
                        accepted: 0
                        dismissed: 0
                      filtered_question: null
                      content_filter: []
                      localized_data: {}
                    pubnub_timetoken: 17884118520160558
          description: Created
      parameters:
      - in: path
        name: chat_room_id
        schema:
          type: string
        required: true
        description: Chat room uuid
      summary: Send a Widget Chat Message
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                widget_kind:
                  type: string
                  description: e.g text-poll, image-poll, etc
                widget_i:
                  type: string
                  description: Widget's unique uuid
              required:
              - widget_kind
            examples:
              New Example:
                summary: New Example
                value:
                  widget_kind: text-poll
                  widget_id: 17df95e7-9265-49d2-8269-27fc197e0d86
      operationId: post_chat-room-id-widget-messages
      x-internal: false
      tags:
      - Widget Messages
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://docs.livelike.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.livelike.com/reference/add-bulk-chat-memberships.md
  - https://docs.livelike.com/reference/add-members-to-group.md
  - https://docs.livelike.com/reference/add-quest-badges.md
  - https://docs.livelike.com/reference/award-a-badge-to-a-user.md
  - https://docs.livelike.com/reference/batch-invoke-reward-action.md
  - https://docs.livelike.com/reference/claim-user-quest-badges.md
  - https://docs.livelike.com/reference/claim-user-quest-rewards.md
  - https://docs.livelike.com/reference/create-a-base-role.md
  - https://docs.livelike.com/reference/create-a-cheer-meter.md
  - https://docs.livelike.com/reference/create-a-comment-board.md
  - https://docs.livelike.com/reference/create-a-comment.md
  - https://docs.livelike.com/reference/create-a-flair-assignment.md
  - https://docs.livelike.com/reference/create-a-flair-scope.md
  - https://docs.livelike.com/reference/create-a-flair.md
  - https://docs.livelike.com/reference/create-a-group.md
  - https://docs.livelike.com/reference/create-a-pin-message.md
  - https://docs.livelike.com/reference/create-a-pinned-comment.md
  - https://docs.livelike.com/reference/create-a-profile-block.md
  - https://docs.livelike.com/reference/create-a-profile-relationship.md
  - https://docs.livelike.com/reference/create-a-program-ban.md
  - https://docs.livelike.com/reference/create-a-redemption-key.md
  - https://docs.livelike.com/reference/create-a-registered-link.md
  - https://docs.livelike.com/reference/create-a-relationship-type.md
  - https://docs.livelike.com/reference/create-a-rich-post.md
  - https://docs.livelike.com/reference/create-a-social-embed.md
  - https://docs.livelike.com/reference/create-a-sticker.md
  - https://docs.livelike.com/reference/create-a-text-quiz.md
  - https://docs.livelike.com/reference/create-a-user-reaction.md
  - https://docs.livelike.com/reference/create-a-user-tier.md
  - https://docs.livelike.com/reference/create-a-video-alert.md
  - https://docs.livelike.com/reference/create-an-access-rule-for-muteglobally-mute.md
  - https://docs.livelike.com/reference/create-an-alert.md
  - https://docs.livelike.com/reference/create-an-image-number-prediction.md
  - https://docs.livelike.com/reference/create-an-image-quiz.md
  - https://docs.livelike.com/reference/create-an-image-slider.md
  - https://docs.livelike.com/reference/create-badge-1.md
  - https://docs.livelike.com/reference/create-comment-report.md
  - https://docs.livelike.com/reference/create-comments-ban.md
  - https://docs.livelike.com/reference/create-image-number-prediction-follow-up.md
  - https://docs.livelike.com/reference/create-image-number-prediction-option.md
  - https://docs.livelike.com/reference/create-image-poll.md
  - https://docs.livelike.com/reference/create-image-prediction-follow-up.md
  - https://docs.livelike.com/reference/create-image-prediction-option.md
  - https://docs.livelike.com/reference/create-poll-vote.md
  - https://docs.livelike.com/reference/create-profile-by-custom-id.md
  - https://docs.livelike.com/reference/create-quality-rules.md
  - https://docs.livelike.com/reference/create-quest-rewards.md
  - https://docs.livelike.com/reference/create-quests.md
  - https://docs.livelike.com/reference/create-reaction-emoji.md
  - https://docs.livelike.com/reference/create-reward-item.md
  - https://docs.livelike.com/reference/create-reward-table-entry.md
  - https://docs.livelike.com/reference/create-reward-table.md
  - https://docs.livelike.com/reference/create-role-assignments.md
  - https://docs.livelike.com/reference/create-role-grant-assignment.md
  - https://docs.livelike.com/reference/create-roles.md
  - https://docs.livelike.com/reference/create-task.md
  - https://docs.livelike.com/reference/create-text-poll.md
  - https://docs.livelike.com/reference/create-text-prediction-follow-up.md
  - https://docs.livelike.com/reference/create-text-prediction-option.md
  - https://docs.livelike.com/reference/create-tier-benefit.md
  - https://docs.livelike.com/reference/create-tier-group.md
  - https://docs.livelike.com/reference/create-tier.md
  - https://docs.livelike.com/reference/create-user-profile.md
  - https://docs.livelike.com/reference/create-user-quest.md
  - https://docs.livelike.com/reference/creating-reward-actions.md
  - https://docs.livelike.com/reference/credit-reward-item.md
  - https://docs.livelike.com/reference/debit-reward-item.md
  - https://docs.livelike.com/reference/delete-a-base-role.md
  - https://docs.livelike.com/reference/delete-a-comment.md
  - https://docs.livelike.com/reference/delete-a-flair-assignment.md
  - https://docs.livelike.com/reference/delete-a-flair.md
  - https://docs.livelike.com/reference/delete-a-program-ban.md
  - https://docs.livelike.com/reference/delete-a-redemption-key.md
  - https://docs.livelike.com/reference/delete-a-registered-link.md
  - https://docs.livelike.com/reference/delete-a-role.md
  - https://docs.livelike.com/reference/delete-a-tier-group.md
  - https://docs.livelike.com/reference/delete-a-user-reaction.md
  - https://docs.livelike.com/reference/delete-a-video-alert.md
  - https://docs.livelike.com/reference/delete-bulk-chat-memberships.md
  - https://docs.livelike.com/reference/delete-comment-board-by-custom-id.md
  - https://docs.livelike.com/reference/delete-comment-board.md
  - https://docs.livelike.com/reference/delete-comments-ban.md
  - https://docs.livelike.com/reference/delete-profile-group.md
  - https://docs.livelike.com/reference/delete-quest.md
  - https://docs.livelike.com/reference/delete-reaction-emoji.md
  - https://docs.livelike.com/reference/delete-reward-table-entry.md
  - https://docs.livelike.com/reference/delete-reward-table.md
  - https://docs.livelike.com/reference/delete-role-assignment.md
  - https://docs.livelike.com/reference/delete-role-grant-unassignment.md
  - https://docs.livelike.com/reference/delete-task.md
  - https://docs.livelike.com/reference/delete-tier-benefit.md
  - https://docs.livelike.com/reference/delete-tier.md
  - https://docs.livelike.com/reference/delete-userquest.md
  - https://docs.livelike.com/reference/delete-widget.md
  - https://docs.livelike.com/reference/dismiss-all-reports-for-a-reported-comment.md
  - https://docs.livelike.com/reference/flair-assignment-detail.md
  - https://docs.livelike.com/reference/flair-detail-1.md
  - https://docs.livelike.com/reference/flair-detail.md
  - https://docs.livelike.com/reference/get-a-badge.md
  - https://docs.livelike.com/reference/get-a-redemption-key.md
  - https://docs.livelike.com/reference/get-a-rich-post.md
  - https://docs.livelike.com/reference/get-a-social-embed.md
  - https://docs.livelike.com/reference/get-a-text-ask-widget.md
  - https://docs.livelike.com/reference/get-a-text-poll.md
  - https://docs.livelike.com/reference/get-a-text-quiz.md
  - https://docs.livelike.com/reference/get-a-video-alert.md
  - https://docs.livelike.com/reference/get-an-alert-1.md
  - https://docs.livelike.com/reference/get-an-asset-1.md
  - https://docs.livelike.com/reference/get-an-asset.md
  - https://docs.livelike.com/reference/get-an-emoji-slider.md
  - https://docs.livelike.com/reference/get-an-image-poll.md
  - https://docs.livelike.com/reference/get-an-image-quiz.md
  - https://docs.livelike.com/reference/get-blocked-profile-ids.md
  - https://docs.livelike.com/reference/get-blocked-profiles.md
  - https://docs.livelike.com/reference/get-chatroom-message-count.md
  - https://docs.livelike.com/reference/get-chatroom-messages.md
  - https://docs.livelike.com/reference/get-comment-board-by-custom_id.md
  - https://docs.livelike.com/reference/get-comment-counts.md
  - https://docs.livelike.com/reference/get-image-number-prediction.md
  - https://docs.livelike.com/reference/get-leaderboard-by-custom-id.md
  - https://docs.livelike.com/reference/get-list-of-base-roles.md
  - https://docs.livelike.com/reference/get-list-of-comment-board-bans.md
  - https://docs.livelike.com/reference/get-list-of-comment-reports.md
  - https://docs.livelike.com/reference/get-list-of-earned-badges.md
  - https://docs.livelike.com/reference/get-list-of-quest-rewards.md
  - https://docs.livelike.com/reference/get-list-of-resources.md
  - https://docs.livelike.com/reference/get-pinned-message-info.md
  - https://docs.livelike.com/reference/get-profile-by-custom-id.md
  - https://docs.livelike.com/reference/get-profile-group-detail.md
  - https://docs.livelike.com/reference/get-profile-group-members.md
  - https://docs.livelike.com/reference/get-program-bans.md
  - https://docs.livelike.com/reference/get-program-by-custom-id.md
  - https://docs.livelike.com/reference/get-quest-badges.md
  - https://docs.livelike.com/reference/get-quests.md
  - https://docs.livelike.com/reference/get-reaction-space-by-target-group-id.md
  - https://docs.livelike.com/reference/get-reported-chat-messages.md
  - https://docs.livelike.com/reference/get-reward-item-balance.md
  - https://docs.livelike.com/reference/get-reward-table-entry.md
  - https://docs.livelike.com/reference/get-reward-table.md
  - https://docs.livelike.com/reference/get-role-templates.md
  - https://docs.livelike.com/reference/get-roles.md
  - https://docs.livelike.com/reference/get-task.md
  - https://docs.livelike.com/reference/get-the-list-of-comment-boards.md
  - https://docs.livelike.com/reference/get-user-quest-rewards.md
  - https://docs.livelike.com/reference/get-user-reaction-count-per-space.md
  - https://docs.livelike.com/reference/get-user-reaction-count.md
  - https://docs.livelike.com/reference/get-users-badges.md
  - https://docs.livelike.com/reference/get_reaction-space-by-target-group-id-client-id-target-group-id-1.md
  - https://docs.livelike.com/reference/invoking-custom-actions.md
  - https://docs.livelike.com/reference/list-assets.md
  - https://docs.livelike.com/reference/list-available-badges.md
  - https://docs.livelike.com/reference/list-badge-progress.md
  - https://docs.livelike.com/reference/list-comments-by-author.md
  - https://docs.livelike.com/reference/list-comments.md
  - https://docs.livelike.com/reference/list-flair-assignments.md
  - https://docs.livelike.com/reference/list-flairs-1.md
  - https://docs.livelike.com/reference/list-flairs.md
  - https://docs.livelike.com/reference/list-invoked-reward-actions.md
  - https://docs.livelike.com/reference/list-permissions.md
  - https://docs.livelike.com/reference/list-pinned-comments.md
  - https://docs.livelike.com/reference/list-profile-relationships.md
  - https://docs.livelike.com/reference/list-profiles-who-have-earned-a-specific-badge.md
  - https://docs.livelike.com/reference/list-program-sponsors.md
  - https://docs.livelike.com/reference/list-quests.md
  - https://docs.livelike.com/reference/list-reaction-spaces.md
  - https://docs.livelike.com/reference/list-redemption-keys.md
  - https://docs.livelike.com/reference/list-registered-links.md
  - https://docs.livelike.com/reference/list-relationship-types.md
  - https://docs.livelike.com/reference/list-replies-to-profiles-comments.md
  - https://docs.livelike.com/reference/list-reward-actions.md
  - https://docs.livelike.com/reference/list-reward-item-balances.md
  - https://docs.livelike.com/reference/list-reward-item-transfers.md
  - https://docs.livelike.com/reference/list-reward-items.md
  - https://docs.livelike.com/reference/list-reward-tables.md
  - https://docs.livelike.com/reference/list-reward-transactions.md
  - https://docs.livelike.com/reference/list-rich-posts-1-1.md
  - https://docs.livelike.com/reference/list-rich-posts-1.md
  - https://docs.livelike.com/reference/list-rich-posts.md
  - https://docs.livelike.com/reference/list-role-assignments.md
  - https://docs.livelike.com/reference/list-tasks.md
  - https://docs.livelike.com/reference/list-tier-benefits.md
  - https://docs.livelike.com/reference/list-tier-groups.md
  - https://docs.livelike.com/reference/list-tier-transactions.md
  - https://docs.livelike.com/reference/list-tier.md
  - https://docs.livelike.com/reference/list-user-quests.md
  - https://docs.livelike.com/reference/list-user-reactions.md
  - https://docs.livelike.com/reference/list-user-tiers.md
  - https://docs.livelike.com/reference/list-widget-reports.md
  - https://docs.livelike.com/reference/moderate-a-widget-report.md
  - https://docs.livelike.com/reference/patch-update-a-base-role.md
  - https://docs.livelike.com/reference/patch-update-a-role-copy.md
  - https://docs.livelike.com/reference/patch_reaction-space-by-target-group-id-client-id-target-group-id-1-1.md
  - https://docs.livelike.com/reference/prizeout-user-session.md
  - https://docs.livelike.com/reference/profile-permissions-check.md
  - https://docs.livelike.com/reference/publish-widget.md
  - https://docs.livelike.com/reference/put-update-a-base-role.md
  - https://docs.livelike.com/reference/remove-a-chatroom-access-rule.md
  - https://docs.livelike.com/reference/remove-a-quest-reward.md
  - https://docs.livelike.com/reference/remove-badge-from-quest.md
  - https://docs.livelike.com/reference/remove-members-from-group.md
  - https://docs.livelike.com/reference/report-a-widget.md
  - https://docs.livelike.com/reference/retrieve-a-tier.md
  - https://docs.livelike.com/reference/retrieve-reward-item.md
  - https://docs.livelike.com/reference/retrieve-tier-benefit.md
  - https://docs.livelike.com/reference/revoke-earned-badge.md
  - https://docs.livelike.com/reference/reward-item-transfers.md
  - https://docs.livelike.com/reference/role-grant-detail.md
  - https://docs.livelike.com/reference/role-grants-list.md
  - https://docs.livelike.com/reference/send-a-widget-chat-message.md
  - https://docs.livelike.com/reference/send-chat-message.md
  - https://docs.livelike.com/reference/unassignment-by-natural-key.md
  - https://docs.livelike.com/reference/unblock-profile-by-profile-custom-id.md
  - https://docs.livelike.com/reference/unblock-profile.md
  - https://docs.livelike.com/reference/unpin-a-pinned-comment.md
  - https://docs.livelike.com/reference/unpin-message.md
  - https://docs.livelike.com/reference/update-a-comment-board.md
  - https://docs.livelike.com/reference/update-a-comment.md
  - https://docs.livelike.com/reference/update-a-flair-1.md
  - https://docs.livelike.com/reference/update-a-flair-assignment.md
  - https://docs.livelike.com/reference/update-a-flair.md
  - https://docs.livelike.com/reference/update-a-redemption-key-by-code.md
  - https://docs.livelike.com/reference/update-a-redemption-key.md
  - https://docs.livelike.com/reference/update-a-role.md
  - https://docs.livelike.com/reference/update-a-video-alert.md
  - https://docs.livelike.com/reference/update-comment-board-by-custom-id.md
  - https://docs.livelike.com/reference/update-comment-quality-rules.md
  - https://docs.livelike.com/reference/update-image-number-prediction-option.md
  - https://docs.livelike.com/reference/update-image-number-prediction.md
  - https://docs.livelike.com/reference/update-image-prediction-option.md
  - https://docs.livelike.com/reference/update-profile-group.md
  - https://docs.livelike.com/reference/update-reaction-emoji.md
  - https://docs.livelike.com/reference/update-text-prediction-option.md
  - https://docs.livelike.com/reference/update-tier-benefit.md
  - https://docs.livelike.com/reference/update-tier-group.md
  - https://docs.livelike.com/reference/update-tier.md
  - https://docs.livelike.com/reference/update-user-quest-task-progress.md
  - https://docs.livelike.com/reference/update-user-quest.md
  merge:
    pages: 237
    deduped: 0
    conflicts_kept_first: 0