openapi: 3.2.0 info: title: engagement-suite Invoked Actions API version: '1' servers: - url: https://cf-blast.livelikecdn.com/api/v1 security: - {} tags: - name: Invoked Actions paths: /invoked-actions/: get: summary: List Invoked Reward Actions description: Invoke actions to trigger the rewards engine for that action operationId: list-invoked-reward-actions parameters: - name: client_id in: query description: The application's Client ID required: true schema: type: string - name: code in: query description: The integrator-defined disambiguation code schema: type: string - name: profile_id in: query description: Limit results to a Profile ID. Repeat this parameter to filter for multiple Profile IDs schema: type: string - name: reward_action_key in: query description: Limit results to a Reward Action key. Repeat this parameter to filter for multiple Reward Action keys schema: type: string - name: program_id in: query description: Limit results to a Program ID schema: type: string - name: since in: query description: Filter for Invoked Actions created after a specific Date/Time schema: type: string format: date - name: until in: query description: Filter for Invoked Actions created before a specific Date/Time schema: type: string format: date - name: ordering in: query description: Order results by created Date/Time. Use `-created_at` to see most recent results first schema: type: string default: created_at - name: attributes in: query description: 'Filter for actions with the given attributes. Example: `attributes=key:value`. This parameter can be repeated.' schema: type: string responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": \"9575428e-98a1-4c74-85fc-b2943f024224\",\n \"created_at\": \"2021-01-11T21:57:55.466092Z\",\n \"client_id\": \"pnODbVXg0UI80s0l2aH5Y7FOuGbftoAdSNqpdvo6\",\n \"program_id\": \"47c14e1d-5786-401e-a850-22c5a91a5399\",\n \"profile_id\": \"d70d8ad0-0753-4f2e-b00c-6defc295def7\",\n \"profile_nickname\": \"Expert Trainer\",\n \"reward_action_key\": \"hulk-slam\",\n \"code\": \"2021-01-11\",\n \"rewards\": [\n {\n \"reward_item_id\": \"ceb8b15e-3cee-480f-b25c-68817ac1afc0\",\n \"reward_item_name\": \"Hulk Points\",\n \"reward_item_amount\": 100\n }\n ]\n }\n ]\n}\n" schema: type: object properties: count: type: integer example: 1 default: 0 next: {} previous: {} results: type: array items: type: object properties: id: type: string example: 9575428e-98a1-4c74-85fc-b2943f024224 created_at: type: string example: '2021-01-11T21:57:55.466092Z' client_id: type: string example: pnODbVXg0UI80s0l2aH5Y7FOuGbftoAdSNqpdvo6 program_id: type: string example: 47c14e1d-5786-401e-a850-22c5a91a5399 profile_id: type: string example: d70d8ad0-0753-4f2e-b00c-6defc295def7 profile_nickname: type: string example: Expert Trainer reward_action_key: type: string example: hulk-slam code: type: string example: '2021-01-11' rewards: type: array items: type: object properties: reward_item_id: type: string example: ceb8b15e-3cee-480f-b25c-68817ac1afc0 reward_item_name: type: string example: Hulk Points reward_item_amount: type: integer example: 100 default: 0 '409': description: '409' content: application/json: examples: Result: value: "{\n \"detail\": \"code already used.\"\n}\n" schema: type: object properties: detail: type: string example: code already used. deprecated: false tags: - Invoked Actions post: summary: Invoke Reward Action description: Invoke actions to trigger the rewards engine for that action operationId: invoking-custom-actions parameters: - name: Authorization in: header required: true schema: type: string requestBody: content: application/json: schema: type: object required: - program_id - profile_id - reward_action_key properties: program_id: type: string description: Program ID profile_id: type: string description: Profile ID (Conflicts with Custom profile ID) custom_profile_id: type: string description: Custom profile ID (Conflicts with Profile ID) reward_action_key: type: string description: Reward action key code: type: string description: Integrator-defined disambiguation code attributes: type: array description: Attributes array items: properties: key: type: string value: type: string required: - key - value type: object description: type: string description: Optional description for invoking the action. responses: '201': description: '201' content: application/json: examples: Result: value: "{\n \"id\": \"7f6e1be0-6b8d-43d0-914d-7227c8608ec1\",\n \"created_at\": \"2021-01-09T19:53:34.898831Z\",\n \"program_id\": \"8d1885c6-1635-4d41-8904-76f3e86eeb49\",\n \"profile_id\": \"947d3a03-f87f-4146-8e32-043db3fdd25f\",\n \"reward_action_key\": \"my-custom-action\",\n \"code\": \"my-disambiguation-code,\n \"rewards\": [\n {\n \"reward_item_id\": \"194d4d03-b7c0-4b72-bf7f-1974c92a4709\",\n \"reward_item_name\": \"Test Points\",\n \"reward_item_amount\": 5\n }\n ],\n \"description\": \"Sample Description.\"\n}\n" '400': description: '400' content: application/json: examples: Both Profile Id and Custom Id are provided: value: '{"detail":"Body params profile_uuid and custom_profile_id must not be passed together."}' Missing Profile Id and Custom Id: value: '{"detail":"profile_id or custom_profile_id is required."}' Profile Id - not valid UUID: value: '{"detail":"profile_id is not a valid UUID."}' schema: oneOf: - title: Both Profile Id and Custom Id are provided type: object properties: detail: type: string example: Body params profile_uuid and custom_profile_id must not be passed together. - title: Missing Profile Id and Custom Id type: object properties: detail: type: string example: profile_id or custom_profile_id is required. - title: Profile Id - not valid UUID type: object properties: detail: type: string example: profile_id is not a valid UUID. '404': description: '404' content: application/json: examples: Profile Id only - Not Found: value: '{"detail":"No profile found from input profile uuid."}' Result: value: '{"detail":"No profile found from input profile uuid."}' schema: oneOf: - title: Profile Id only - Not Found type: object properties: detail: type: string example: No profile found from input profile uuid. - type: object properties: detail: type: string example: No profile found from input profile uuid. '409': description: '409' content: application/json: examples: Result: value: "{\n \"detail\": \"code already used.\"\n}\n" schema: type: object properties: detail: type: string example: code already used. deprecated: false tags: - Invoked Actions 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