{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/entertainment:twitch/start-commercial":{"post":{"operationId":"entertainment_twitch_start_commercial","summary":"Starts a commercial on the specified channel.","description":"POST /channels/commercial","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-ad-schedule":{"get":{"operationId":"entertainment_twitch_get_ad_schedule","summary":"Returns ad schedule related information.","description":"GET /channels/ads","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"Provided `broadcaster_id` must match the `user_id` in the auth token.","schema":{"type":"string","description":"Provided `broadcaster_id` must match the `user_id` in the auth token."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/snooze-next-ad":{"post":{"operationId":"entertainment_twitch_snooze_next_ad","summary":"Pushes back the timestamp of the upcoming automatic mid-roll ad by 5 minutes.","description":"POST /channels/ads/schedule/snooze","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id"],"properties":{"broadcaster_id":{"type":"string","description":"Provided `broadcaster_id` must match the `user_id` in the auth token."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-extension-analytics":{"get":{"operationId":"entertainment_twitch_get_extension_analytics","summary":"Gets an analytics report for one or more extensions.","description":"GET /analytics/extensions","tags":["entertainment"],"parameters":[{"name":"extension_id","in":"query","required":false,"description":"The extension's client ID. If specified, the response contains a report for the specified extension. If not specified, the response…","schema":{"type":"string","description":"The extension's client ID. If specified, the response contains a report for the specified extension. If not specified, the response…"}},{"name":"type","in":"query","required":false,"description":"The type of analytics report to get. Possible values are: * overview\\_v2","schema":{"type":"string","enum":["overview_v2"],"description":"The type of analytics report to get. Possible values are: * overview\\_v2"}},{"name":"started_at","in":"query","required":false,"description":"The reporting window's start date, in RFC3339 format. Set the time portion to zeroes (for example, 2021-10-22T00:00:00Z). The start date…","schema":{"type":"string","description":"The reporting window's start date, in RFC3339 format. Set the time portion to zeroes (for example, 2021-10-22T00:00:00Z). The start date…"}},{"name":"ended_at","in":"query","required":false,"description":"The reporting window's end date, in RFC3339 format. Set the time portion to zeroes (for example, 2021-10-27T00:00:00Z). The report is…","schema":{"type":"string","description":"The reporting window's end date, in RFC3339 format. Set the time portion to zeroes (for example, 2021-10-27T00:00:00Z). The report is…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of report URLs to return per page in the response. The minimum page size is 1 URL per page and the maximum is 100 URLs…","schema":{"type":"integer","description":"The maximum number of report URLs to return per page in the response. The minimum page size is 1 URL per page and the maximum is 100 URLs…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-game-analytics":{"get":{"operationId":"entertainment_twitch_get_game_analytics","summary":"Gets an analytics report for one or more games.","description":"GET /analytics/games","tags":["entertainment"],"parameters":[{"name":"game_id","in":"query","required":false,"description":"The game’s client ID. If specified, the response contains a report for the specified game. If not specified, the response includes a…","schema":{"type":"string","description":"The game’s client ID. If specified, the response contains a report for the specified game. If not specified, the response includes a…"}},{"name":"type","in":"query","required":false,"description":"The type of analytics report to get. Possible values are: * overview\\_v2","schema":{"type":"string","enum":["overview_v2"],"description":"The type of analytics report to get. Possible values are: * overview\\_v2"}},{"name":"started_at","in":"query","required":false,"description":"The reporting window’s start date, in RFC3339 format. Set the time portion to zeroes (for example, 2021-10-22T00:00:00Z). If you specify a…","schema":{"type":"string","description":"The reporting window’s start date, in RFC3339 format. Set the time portion to zeroes (for example, 2021-10-22T00:00:00Z). If you specify a…"}},{"name":"ended_at","in":"query","required":false,"description":"The reporting window’s end date, in RFC3339 format. Set the time portion to zeroes (for example, 2021-10-22T00:00:00Z). The report is…","schema":{"type":"string","description":"The reporting window’s end date, in RFC3339 format. Set the time portion to zeroes (for example, 2021-10-22T00:00:00Z). The report is…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of report URLs to return per page in the response. The minimum page size is 1 URL per page and the maximum is 100 URLs…","schema":{"type":"integer","description":"The maximum number of report URLs to return per page in the response. The minimum page size is 1 URL per page and the maximum is 100 URLs…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-bits-leaderboard":{"get":{"operationId":"entertainment_twitch_get_bits_leaderboard","summary":"Gets the Bits leaderboard for the authenticated broadcaster.","description":"GET /bits/leaderboard","tags":["entertainment"],"parameters":[{"name":"count","in":"query","required":false,"description":"The number of results to return. The minimum count is 1 and the maximum is 100\\. The default is 10.","schema":{"type":"integer","description":"The number of results to return. The minimum count is 1 and the maximum is 100\\. The default is 10."}},{"name":"period","in":"query","required":false,"description":"The time period over which data is aggregated (uses the PST time zone). Possible values are: * day — A day spans from 00:00:00 on the day…","schema":{"type":"string","enum":["day","week","month","year","all"],"description":"The time period over which data is aggregated (uses the PST time zone). Possible values are: * day — A day spans from 00:00:00 on the day…"}},{"name":"started_at","in":"query","required":false,"description":"The start date, in RFC3339 format, used for determining the aggregation period. Specify this parameter only if you specify the _period_…","schema":{"type":"string","description":"The start date, in RFC3339 format, used for determining the aggregation period. Specify this parameter only if you specify the _period_…"}},{"name":"user_id","in":"query","required":false,"description":"An ID that identifies a user that cheered bits in the channel. If _count_ is greater than 1, the response may include users ranked above…","schema":{"type":"string","description":"An ID that identifies a user that cheered bits in the channel. If _count_ is greater than 1, the response may include users ranked above…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-cheermotes":{"get":{"operationId":"entertainment_twitch_get_cheermotes","summary":"Gets a list of Cheermotes that users can use to cheer Bits.","description":"GET /bits/cheermotes","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":false,"description":"The ID of the broadcaster whose custom Cheermotes you want to get. Specify the broadcaster’s ID if you want to include the broadcaster’s…","schema":{"type":"string","description":"The ID of the broadcaster whose custom Cheermotes you want to get. Specify the broadcaster’s ID if you want to include the broadcaster’s…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-custom-power-up":{"get":{"operationId":"entertainment_twitch_get_custom_power_up","summary":"NEW Gets a list of custom Power-ups that the specified broadcaster created.","description":"GET /bits/custom_power_ups","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster whose custom Power-ups you want to get. This ID must match the user ID found in the OAuth token.","schema":{"type":"string","description":"The ID of the broadcaster whose custom Power-ups you want to get. This ID must match the user ID found in the OAuth token."}},{"name":"id","in":"query","required":false,"description":"A list of IDs to filter the Power-ups by. To specify more than one ID, include this parameter for each Power-up you want to get. For…","schema":{"type":"array","description":"A list of IDs to filter the Power-ups by. To specify more than one ID, include this parameter for each Power-up you want to get. For…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-extension-transactions":{"get":{"operationId":"entertainment_twitch_get_extension_transactions","summary":"Gets an extension’s list of transactions.","description":"GET /extensions/transactions","tags":["entertainment"],"parameters":[{"name":"extension_id","in":"query","required":true,"description":"The ID of the extension whose list of transactions you want to get.","schema":{"type":"string","description":"The ID of the extension whose list of transactions you want to get."}},{"name":"id","in":"query","required":false,"description":"A transaction ID used to filter the list of transactions. Specify this parameter for each transaction you want to get. For example,…","schema":{"type":"array","description":"A transaction ID used to filter the list of transactions. Specify this parameter for each transaction you want to get. For example,…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…","schema":{"type":"integer","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-channel-information":{"get":{"operationId":"entertainment_twitch_get_channel_information","summary":"Gets information about one or more channels.","description":"GET /channels","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster whose channel you want to get. To specify more than one ID, include this parameter for each broadcaster you want…","schema":{"type":"array","description":"The ID of the broadcaster whose channel you want to get. To specify more than one ID, include this parameter for each broadcaster you want…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/modify-channel-information":{"post":{"operationId":"entertainment_twitch_modify_channel_information","summary":"Updates a channel’s properties.","description":"PATCH /channels","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster whose channel you want to update. This ID must match the user ID in the user access token."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-channel-editors":{"get":{"operationId":"entertainment_twitch_get_channel_editors","summary":"Gets the broadcaster’s list editors.","description":"GET /channels/editors","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster that owns the channel. This ID must match the user ID in the access token.","schema":{"type":"string","description":"The ID of the broadcaster that owns the channel. This ID must match the user ID in the access token."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-followed-channels":{"get":{"operationId":"entertainment_twitch_get_followed_channels","summary":"Gets a list of broadcasters that the specified user follows. You can also use this endpoint to see whether a…","description":"GET /channels/followed","tags":["entertainment"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"A user’s ID. Returns the list of broadcasters that this user follows. This ID must match the user ID in the user OAuth token.","schema":{"type":"string","description":"A user’s ID. Returns the list of broadcasters that this user follows. This ID must match the user ID in the user OAuth token."}},{"name":"broadcaster_id","in":"query","required":false,"description":"A broadcaster’s ID. Use this parameter to see whether the user follows this broadcaster. If specified, the response contains this…","schema":{"type":"string","description":"A broadcaster’s ID. Use this parameter to see whether the user follows this broadcaster. If specified, the response contains this…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100\\. The…","schema":{"type":"integer","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100\\. The…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-channel-followers":{"get":{"operationId":"entertainment_twitch_get_channel_followers","summary":"Gets a list of users that follow the specified broadcaster. You can also use this endpoint to see whether a…","description":"GET /channels/followers","tags":["entertainment"],"parameters":[{"name":"user_id","in":"query","required":false,"description":"A user’s ID. Use this parameter to see whether the user follows this broadcaster. If specified, the response contains this user if they…","schema":{"type":"string","description":"A user’s ID. Use this parameter to see whether the user follows this broadcaster. If specified, the response contains this user if they…"}},{"name":"broadcaster_id","in":"query","required":true,"description":"The broadcaster’s ID. Returns the list of users that follow this broadcaster.","schema":{"type":"string","description":"The broadcaster’s ID. Returns the list of users that follow this broadcaster."}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100\\. The…","schema":{"type":"integer","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100\\. The…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-custom-reward":{"get":{"operationId":"entertainment_twitch_get_custom_reward","summary":"Gets a list of custom rewards that the specified broadcaster created.","description":"GET /channel_points/custom_rewards","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster whose custom rewards you want to get. This ID must match the user ID found in the OAuth token.","schema":{"type":"string","description":"The ID of the broadcaster whose custom rewards you want to get. This ID must match the user ID found in the OAuth token."}},{"name":"id","in":"query","required":false,"description":"A list of IDs to filter the rewards by. To specify more than one ID, include this parameter for each reward you want to get. For example,…","schema":{"type":"array","description":"A list of IDs to filter the rewards by. To specify more than one ID, include this parameter for each reward you want to get. For example,…"}},{"name":"only_manageable_rewards","in":"query","required":false,"description":"A Boolean value that determines whether the response contains only the custom rewards that the app may manage (the app is identified by…","schema":{"type":"boolean","description":"A Boolean value that determines whether the response contains only the custom rewards that the app may manage (the app is identified by…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/create-custom-rewards":{"post":{"operationId":"entertainment_twitch_create_custom_rewards","summary":"Creates a Custom Reward in the broadcaster’s channel.","description":"POST /channel_points/custom_rewards","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster to add the custom reward to. This ID must match the user ID found in the OAuth token."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-custom-reward":{"post":{"operationId":"entertainment_twitch_update_custom_reward","summary":"Updates a custom reward.","description":"PATCH /channel_points/custom_rewards","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that’s updating the reward. This ID must match the user ID found in the OAuth token."},"id":{"type":"string","description":"The ID of the reward to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/delete-custom-reward":{"post":{"operationId":"entertainment_twitch_delete_custom_reward","summary":"Deletes a custom reward that the broadcaster created.","description":"DELETE /channel_points/custom_rewards","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that created the custom reward. This ID must match the user ID found in the OAuth token."},"id":{"type":"string","description":"The ID of the custom reward to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-custom-reward-redemption":{"get":{"operationId":"entertainment_twitch_get_custom_reward_redemption","summary":"Gets a list of redemptions for a custom reward.","description":"GET /channel_points/custom_rewards/redemptions","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster that owns the custom reward. This ID must match the user ID found in the user OAuth token.","schema":{"type":"string","description":"The ID of the broadcaster that owns the custom reward. This ID must match the user ID found in the user OAuth token."}},{"name":"reward_id","in":"query","required":true,"description":"The ID that identifies the custom reward whose redemptions you want to get.","schema":{"type":"string","description":"The ID that identifies the custom reward whose redemptions you want to get."}},{"name":"status","in":"query","required":false,"description":"The status of the redemptions to return. The possible case-sensitive values are: * CANCELED * FULFILLED * UNFULFILLED **NOTE**: This field…","schema":{"type":"string","enum":["CANCELED","FULFILLED","UNFULFILLED"],"description":"The status of the redemptions to return. The possible case-sensitive values are: * CANCELED * FULFILLED * UNFULFILLED **NOTE**: This field…"}},{"name":"id","in":"query","required":false,"description":"A list of IDs to filter the redemptions by. To specify more than one ID, include this parameter for each redemption you want to get. For…","schema":{"type":"array","description":"A list of IDs to filter the redemptions by. To specify more than one ID, include this parameter for each redemption you want to get. For…"}},{"name":"sort","in":"query","required":false,"description":"The order to sort redemptions by. The possible case-sensitive values are: * OLDEST * NEWEST The default is OLDEST.","schema":{"type":"string","enum":["OLDEST","NEWEST"],"description":"The order to sort redemptions by. The possible case-sensitive values are: * OLDEST * NEWEST The default is OLDEST."}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of redemptions to return per page in the response. The minimum page size is 1 redemption per page and the maximum is…","schema":{"type":"integer","description":"The maximum number of redemptions to return per page in the response. The minimum page size is 1 redemption per page and the maximum is…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-redemption-status":{"post":{"operationId":"entertainment_twitch_update_redemption_status","summary":"Updates a redemption’s status.","description":"PATCH /channel_points/custom_rewards/redemptions","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","broadcaster_id","reward_id"],"properties":{"id":{"type":"array","description":"A list of IDs that identify the redemptions to update. To specify more than one ID, include this parameter for each redemption you want to…"},"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that’s updating the redemption. This ID must match the user ID in the user access token."},"reward_id":{"type":"string","description":"The ID that identifies the reward that’s been redeemed."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-charity-campaign":{"get":{"operationId":"entertainment_twitch_get_charity_campaign","summary":"Gets information about the broadcaster’s active charity campaign.","description":"GET /charity/campaigns","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster that’s currently running a charity campaign. This ID must match the user ID in the access token.","schema":{"type":"string","description":"The ID of the broadcaster that’s currently running a charity campaign. This ID must match the user ID in the access token."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-charity-campaign-donations":{"get":{"operationId":"entertainment_twitch_get_charity_campaign_donations","summary":"Gets the list of donations that users have made to the broadcaster’s active charity campaign.","description":"GET /charity/donations","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster that’s currently running a charity campaign. This ID must match the user ID in the access token.","schema":{"type":"string","description":"The ID of the broadcaster that’s currently running a charity campaign. This ID must match the user ID in the access token."}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100\\. The…","schema":{"type":"integer","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100\\. The…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-chatters":{"get":{"operationId":"entertainment_twitch_get_chatters","summary":"Gets the list of users that are connected to the broadcaster’s chat session.","description":"GET /chat/chatters","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster whose list of chatters you want to get.","schema":{"type":"string","description":"The ID of the broadcaster whose list of chatters you want to get."}},{"name":"moderator_id","in":"query","required":true,"description":"The ID of the broadcaster or one of the broadcaster’s moderators. This ID must match the user ID in the user access token.","schema":{"type":"string","description":"The ID of the broadcaster or one of the broadcaster’s moderators. This ID must match the user ID in the user access token."}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 1,000\\. The…","schema":{"type":"integer","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 1,000\\. The…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-channel-emotes":{"get":{"operationId":"entertainment_twitch_get_channel_emotes","summary":"Gets the broadcaster’s list of custom emotes.","description":"GET /chat/emotes","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"An ID that identifies the broadcaster whose emotes you want to get.","schema":{"type":"string","description":"An ID that identifies the broadcaster whose emotes you want to get."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-global-emotes":{"get":{"operationId":"entertainment_twitch_get_global_emotes","summary":"Gets all global emotes.","description":"GET /chat/emotes/global","tags":["entertainment"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-emote-sets":{"get":{"operationId":"entertainment_twitch_get_emote_sets","summary":"Gets emotes for one or more specified emote sets.","description":"GET /chat/emotes/set","tags":["entertainment"],"parameters":[{"name":"emote_set_id","in":"query","required":true,"description":"An ID that identifies the emote set to get. Include this parameter for each emote set you want to get. For example,…","schema":{"type":"array","description":"An ID that identifies the emote set to get. Include this parameter for each emote set you want to get. For example,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-channel-chat-badges":{"get":{"operationId":"entertainment_twitch_get_channel_chat_badges","summary":"Gets the broadcaster’s list of custom chat badges.","description":"GET /chat/badges","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster whose chat badges you want to get.","schema":{"type":"string","description":"The ID of the broadcaster whose chat badges you want to get."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-global-chat-badges":{"get":{"operationId":"entertainment_twitch_get_global_chat_badges","summary":"Gets Twitch’s list of chat badges.","description":"GET /chat/badges/global","tags":["entertainment"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-chat-settings":{"get":{"operationId":"entertainment_twitch_get_chat_settings","summary":"Gets the broadcaster’s chat settings.","description":"GET /chat/settings","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster whose chat settings you want to get.","schema":{"type":"string","description":"The ID of the broadcaster whose chat settings you want to get."}},{"name":"moderator_id","in":"query","required":false,"description":"The ID of the broadcaster or one of the broadcaster’s moderators. This field is required only if you want to include the…","schema":{"type":"string","description":"The ID of the broadcaster or one of the broadcaster’s moderators. This field is required only if you want to include the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-chat-settings":{"post":{"operationId":"entertainment_twitch_update_chat_settings","summary":"Updates the broadcaster’s chat settings.","description":"PATCH /chat/settings","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster whose chat settings you want to update."},"moderator_id":{"type":"string","description":"The ID of a user that has permission to moderate the broadcaster’s chat room, or the broadcaster’s ID if they’re making the update. This…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-shared-chat-session":{"get":{"operationId":"entertainment_twitch_get_shared_chat_session","summary":"Retrieves the active shared chat session for a channel.","description":"GET /shared_chat/session","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The User ID of the channel broadcaster.","schema":{"type":"string","description":"The User ID of the channel broadcaster."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-user-emotes":{"get":{"operationId":"entertainment_twitch_get_user_emotes","summary":"Retrieves emotes available to the user across all channels.","description":"GET /chat/emotes/user","tags":["entertainment"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"The ID of the user. This ID must match the user ID in the user access token.","schema":{"type":"string","description":"The ID of the user. This ID must match the user ID in the user access token."}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value.","schema":{"type":"string","description":"The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value."}},{"name":"broadcaster_id","in":"query","required":false,"description":"The User ID of a broadcaster you wish to get follower emotes of. Using this query parameter will guarantee inclusion of the broadcaster’s…","schema":{"type":"string","description":"The User ID of a broadcaster you wish to get follower emotes of. Using this query parameter will guarantee inclusion of the broadcaster’s…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/send-chat-announcement":{"post":{"operationId":"entertainment_twitch_send_chat_announcement","summary":"Sends an announcement to the broadcaster’s chat room.","description":"POST /chat/announcements","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that owns the chat room to send the announcement to."},"moderator_id":{"type":"string","description":"The ID of a user who has permission to moderate the broadcaster’s chat room, or the broadcaster’s ID if they’re sending the announcement."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/send-a-shoutout":{"post":{"operationId":"entertainment_twitch_send_a_shoutout","summary":"Sends a Shoutout to the specified broadcaster.","description":"POST /chat/shoutouts","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["from_broadcaster_id","to_broadcaster_id","moderator_id"],"properties":{"from_broadcaster_id":{"type":"string","description":"The ID of the broadcaster that’s sending the Shoutout."},"to_broadcaster_id":{"type":"string","description":"The ID of the broadcaster that’s receiving the Shoutout."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that is one of the broadcaster’s moderators. This ID must match the user ID in the access token."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/send-chat-message":{"post":{"operationId":"entertainment_twitch_send_chat_message","summary":"Sends a message to the broadcaster’s chat room.","description":"POST /chat/messages","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-pinned-chat-message":{"get":{"operationId":"entertainment_twitch_get_pinned_chat_message","summary":"NEW Gets the currently pinned message for the broadcaster’s chat room.","description":"GET /chat/pins","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster that owns the chat room.","schema":{"type":"string","description":"The ID of the broadcaster that owns the chat room."}},{"name":"moderator_id","in":"query","required":true,"description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room.","schema":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/pin-chat-message":{"post":{"operationId":"entertainment_twitch_pin_chat_message","summary":"NEW Pins a chat message to the specified broadcaster’s chat room.","description":"PUT /chat/pins","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id","message_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that owns the chat room."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room."},"message_id":{"type":"string","description":"The ID of the message to pin."},"duration_seconds":{"type":"integer","description":"The number of seconds the message should be pinned for. Minimum: 30\\. Maximum: 1800\\. If not specified, the message will be pinned until…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-pinned-chat-message":{"post":{"operationId":"entertainment_twitch_update_pinned_chat_message","summary":"NEW Updates the duration of a pinned chat message.","description":"PATCH /chat/pins","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id","message_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that owns the chat room."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room."},"message_id":{"type":"string","description":"The ID of the pinned message to update."},"duration_seconds":{"type":"integer","description":"The new number of seconds the message should remain pinned, starting from now. Minimum: 30\\. Maximum: 1800\\. If not specified, the message…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/unpin-chat-message":{"post":{"operationId":"entertainment_twitch_unpin_chat_message","summary":"NEW Unpins a pinned chat message from the broadcaster’s chat room.","description":"DELETE /chat/pins","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id","message_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that owns the chat room."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room."},"message_id":{"type":"string","description":"The ID of the message to unpin."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-user-chat-color":{"get":{"operationId":"entertainment_twitch_get_user_chat_color","summary":"Gets the color used for the user’s name in chat.","description":"GET /chat/color","tags":["entertainment"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"The ID of the user whose username color you want to get. To specify more than one user, include the _user\\_id_ parameter for each user to…","schema":{"type":"array","description":"The ID of the user whose username color you want to get. To specify more than one user, include the _user\\_id_ parameter for each user to…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-user-chat-color":{"post":{"operationId":"entertainment_twitch_update_user_chat_color","summary":"Updates the color used for the user’s name in chat.","description":"PUT /chat/color","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id","color"],"properties":{"user_id":{"type":"string","description":"The ID of the user whose chat color you want to update. This ID must match the user ID in the access token."},"color":{"type":"string","enum":["blue","blue_violet","cadet_blue","chocolate","coral","dodger_blue","firebrick","golden_rod","green","hot_pink","orange_red","red","sea_green","spring_green","yellow_green"],"description":"The color to use for the user's name in chat. All users may specify one of the following named color values. * blue * blue\\_violet *…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-clips":{"get":{"operationId":"entertainment_twitch_get_clips","summary":"Gets one or more video clips.","description":"GET /clips","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":false,"description":"An ID that identifies the broadcaster whose video clips you want to get. Use this parameter to get clips that were captured from the…","schema":{"type":"string","description":"An ID that identifies the broadcaster whose video clips you want to get. Use this parameter to get clips that were captured from the…"}},{"name":"game_id","in":"query","required":false,"description":"An ID that identifies the game whose clips you want to get. Use this parameter to get clips that were captured from streams that were…","schema":{"type":"string","description":"An ID that identifies the game whose clips you want to get. Use this parameter to get clips that were captured from streams that were…"}},{"name":"id","in":"query","required":false,"description":"An ID that identifies the clip to get. To specify more than one ID, include this parameter for each clip you want to get. For example,…","schema":{"type":"array","description":"An ID that identifies the clip to get. To specify more than one ID, include this parameter for each clip you want to get. For example,…"}},{"name":"started_at","in":"query","required":false,"description":"The start date used to filter clips. The API returns only clips within the start and end date window. Specify the date and time in RFC3339…","schema":{"type":"string","description":"The start date used to filter clips. The API returns only clips within the start and end date window. Specify the date and time in RFC3339…"}},{"name":"ended_at","in":"query","required":false,"description":"The end date used to filter clips. If not specified, the time window is the start date plus one week. Specify the date and time in RFC3339…","schema":{"type":"string","description":"The end date used to filter clips. If not specified, the time window is the start date plus one week. Specify the date and time in RFC3339…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of clips to return per page in the response. The minimum page size is 1 clip per page and the maximum is 100\\. The…","schema":{"type":"integer","description":"The maximum number of clips to return per page in the response. The minimum page size is 1 clip per page and the maximum is 100\\. The…"}},{"name":"before","in":"query","required":false,"description":"The cursor used to get the previous page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the previous page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}},{"name":"is_featured","in":"query","required":false,"description":"A Boolean value that determines whether the response includes featured clips. If **true**, returns only clips that are featured. If…","schema":{"type":"boolean","description":"A Boolean value that determines whether the response includes featured clips. If **true**, returns only clips that are featured. If…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/create-clip":{"post":{"operationId":"entertainment_twitch_create_clip","summary":"Creates a clip from the broadcaster’s stream.","description":"POST /clips","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster whose stream you want to create a clip from."},"title":{"type":"string","description":"The title of the clip."},"duration":{"type":"number","description":"The length of the clip in seconds. Possible values range from 5 to 60 inclusively with a precision of 0.1\\. The default is 30."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/create-clip-from-vod":{"post":{"operationId":"entertainment_twitch_create_clip_from_vod","summary":"NEW Creates a clip from the broadcaster’s VOD.","description":"POST /videos/clips","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["editor_id","broadcaster_id","vod_id","vod_offset","title"],"properties":{"editor_id":{"type":"string","description":"The user ID of the editor for the channel you want to create a clip for. If using the broadcaster’s auth token, this is the same as…"},"broadcaster_id":{"type":"string","description":"The user ID for the channel you want to create a clip for."},"vod_id":{"type":"string","description":"ID of the VOD the user wants to clip."},"vod_offset":{"type":"integer","description":"The zero-based offset, in seconds, to where the clip should end in the video (VOD). See this endpoint’s description for more information…"},"duration":{"type":"number","description":"The length of the clip, in seconds. Precision is 0.1\\. Defaults to 30\\. Min: 5 seconds, Max: 60 seconds."},"title":{"type":"string","description":"The title of the clip."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-clips-download":{"get":{"operationId":"entertainment_twitch_get_clips_download","summary":"NEW Provides URLs to download the video file(s) for the specified clips.","description":"GET /clips/downloads","tags":["entertainment"],"parameters":[{"name":"editor_id","in":"query","required":true,"description":"The User ID of the editor for the channel you want to download a clip for. If using the broadcaster’s auth token, this is the same as…","schema":{"type":"string","description":"The User ID of the editor for the channel you want to download a clip for. If using the broadcaster’s auth token, this is the same as…"}},{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster you want to download clips for.","schema":{"type":"string","description":"The ID of the broadcaster you want to download clips for."}},{"name":"clip_id","in":"query","required":true,"description":"The ID that identifies the clip you want to download. Include this parameter for each clip you want to download, up to a maximum of 10…","schema":{"type":"array","description":"The ID that identifies the clip you want to download. Include this parameter for each clip you want to download, up to a maximum of 10…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-conduits":{"get":{"operationId":"entertainment_twitch_get_conduits","summary":"Gets the conduits for a client ID.","description":"GET /eventsub/conduits","tags":["entertainment"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/create-conduits":{"post":{"operationId":"entertainment_twitch_create_conduits","summary":"Creates a new conduit.","description":"POST /eventsub/conduits","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-conduits":{"post":{"operationId":"entertainment_twitch_update_conduits","summary":"Updates a conduit’s shard count.","description":"PATCH /eventsub/conduits","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/delete-conduit":{"post":{"operationId":"entertainment_twitch_delete_conduit","summary":"Deletes a specified conduit.","description":"DELETE /eventsub/conduits","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Conduit ID."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-conduit-shards":{"get":{"operationId":"entertainment_twitch_get_conduit_shards","summary":"Gets a lists of all shards for a conduit.","description":"GET /eventsub/conduits/shards","tags":["entertainment"],"parameters":[{"name":"conduit_id","in":"query","required":true,"description":"Conduit ID.","schema":{"type":"string","description":"Conduit ID."}},{"name":"status","in":"query","required":false,"description":"Status to filter by.","schema":{"type":"string","description":"Status to filter by."}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The pagination object in the response contains the cursor’s value.","schema":{"type":"string","description":"The cursor used to get the next page of results. The pagination object in the response contains the cursor’s value."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-conduit-shards":{"post":{"operationId":"entertainment_twitch_update_conduit_shards","summary":"Updates shard(s) for a conduit.","description":"PATCH /eventsub/conduits/shards","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-content-classification-labels":{"get":{"operationId":"entertainment_twitch_get_content_classification_labels","summary":"Gets information about Twitch content classification labels.","description":"GET /content_classification_labels","tags":["entertainment"],"parameters":[{"name":"locale","in":"query","required":false,"description":"Locale for the Content Classification Labels. You may specify a maximum of 1 locale. Default: `“en-US”` Supported locales: `\"bg-BG\",…","schema":{"type":"string","description":"Locale for the Content Classification Labels. You may specify a maximum of 1 locale. Default: `“en-US”` Supported locales: `\"bg-BG\",…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-drops-entitlements":{"get":{"operationId":"entertainment_twitch_get_drops_entitlements","summary":"Gets an organization’s list of entitlements that have been granted to a game, a user, or both.","description":"GET /entitlements/drops","tags":["entertainment"],"parameters":[{"name":"id","in":"query","required":false,"description":"An ID that identifies the entitlement to get. Include this parameter for each entitlement you want to get. For example, `id=1234&id=5678`.…","schema":{"type":"array","description":"An ID that identifies the entitlement to get. Include this parameter for each entitlement you want to get. For example, `id=1234&id=5678`.…"}},{"name":"user_id","in":"query","required":false,"description":"An ID that identifies a user that was granted entitlements.","schema":{"type":"string","description":"An ID that identifies a user that was granted entitlements."}},{"name":"game_id","in":"query","required":false,"description":"An ID that identifies a game that offered entitlements.","schema":{"type":"string","description":"An ID that identifies a game that offered entitlements."}},{"name":"fulfillment_status","in":"query","required":false,"description":"The entitlement’s fulfillment status. Used to filter the list to only those with the specified status. Possible values are: * CLAIMED *…","schema":{"type":"string","enum":["CLAIMED","FULFILLED"],"description":"The entitlement’s fulfillment status. Used to filter the list to only those with the specified status. Possible values are: * CLAIMED *…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of entitlements to return per page in the response. The minimum page size is 1 entitlement per page and the maximum is…","schema":{"type":"integer","description":"The maximum number of entitlements to return per page in the response. The minimum page size is 1 entitlement per page and the maximum is…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-drops-entitlements":{"post":{"operationId":"entertainment_twitch_update_drops_entitlements","summary":"Updates the Drop entitlement’s fulfillment status.","description":"PATCH /entitlements/drops","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-extension-configuration-segment":{"get":{"operationId":"entertainment_twitch_get_extension_configuration_segment","summary":"Gets the specified configuration segment from the specified extension.","description":"GET /extensions/configurations","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":false,"description":"The ID of the broadcaster that installed the extension. This parameter is required if you set the _segment_ parameter to broadcaster or…","schema":{"type":"string","description":"The ID of the broadcaster that installed the extension. This parameter is required if you set the _segment_ parameter to broadcaster or…"}},{"name":"extension_id","in":"query","required":true,"description":"The ID of the extension that contains the configuration segment you want to get.","schema":{"type":"string","description":"The ID of the extension that contains the configuration segment you want to get."}},{"name":"segment","in":"query","required":true,"description":"The type of configuration segment to get. Possible case-sensitive values are: * broadcaster * developer * global You may specify one or…","schema":{"type":"string","enum":["broadcaster","developer","global"],"description":"The type of configuration segment to get. Possible case-sensitive values are: * broadcaster * developer * global You may specify one or…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/set-extension-configuration-segment":{"post":{"operationId":"entertainment_twitch_set_extension_configuration_segment","summary":"Updates a configuration segment.","description":"PUT /extensions/configurations","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/set-extension-required-configuration":{"post":{"operationId":"entertainment_twitch_set_extension_required_configuration","summary":"Updates the extension’s required_configuration string.","description":"PUT /extensions/required_configuration","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that installed the extension on their channel."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/send-extension-pubsub-message":{"post":{"operationId":"entertainment_twitch_send_extension_pubsub_message","summary":"Sends a message to one or more viewers.","description":"POST /extensions/pubsub","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-extension-live-channels":{"get":{"operationId":"entertainment_twitch_get_extension_live_channels","summary":"Gets a list of broadcasters that are streaming live and have installed or activated the extension.","description":"GET /extensions/live","tags":["entertainment"],"parameters":[{"name":"extension_id","in":"query","required":true,"description":"The ID of the extension to get. Returns the list of broadcasters that are live and that have installed or activated this extension.","schema":{"type":"string","description":"The ID of the extension to get. Returns the list of broadcasters that are live and that have installed or activated this extension."}},{"name":"first","in":"query","required":false,"description":"The specific maximum number of items per page in the response. The actual number returned may be less than this limit. [Read…","schema":{"type":"integer","description":"The specific maximum number of items per page in the response. The actual number returned may be less than this limit. [Read…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The `pagination` field in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The `pagination` field in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-extension-secrets":{"get":{"operationId":"entertainment_twitch_get_extension_secrets","summary":"Gets an extension’s list of shared secrets.","description":"GET /extensions/jwt/secrets","tags":["entertainment"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/create-extension-secret":{"post":{"operationId":"entertainment_twitch_create_extension_secret","summary":"Creates a shared secret used to sign and verify JWT tokens.","description":"POST /extensions/jwt/secrets","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["extension_id"],"properties":{"extension_id":{"type":"string","description":"The ID of the extension to apply the shared secret to."},"delay":{"type":"integer","description":"The amount of time, in seconds, to delay activating the secret. The delay should provide enough time for instances of the extension to…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/send-extension-chat-message":{"post":{"operationId":"entertainment_twitch_send_extension_chat_message","summary":"Sends a message to the specified broadcaster’s chat room.","description":"POST /extensions/chat","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that has activated the extension."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-extensions":{"get":{"operationId":"entertainment_twitch_get_extensions","summary":"Gets information about an extension.","description":"GET /extensions","tags":["entertainment"],"parameters":[{"name":"extension_id","in":"query","required":true,"description":"The ID of the extension to get.","schema":{"type":"string","description":"The ID of the extension to get."}},{"name":"extension_version","in":"query","required":false,"description":"The version of the extension to get. If not specified, it returns the latest, released version. If you don’t have a released version, you…","schema":{"type":"string","description":"The version of the extension to get. If not specified, it returns the latest, released version. If you don’t have a released version, you…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-released-extensions":{"get":{"operationId":"entertainment_twitch_get_released_extensions","summary":"Gets information about a released extension.","description":"GET /extensions/released","tags":["entertainment"],"parameters":[{"name":"extension_id","in":"query","required":true,"description":"The ID of the extension to get.","schema":{"type":"string","description":"The ID of the extension to get."}},{"name":"extension_version","in":"query","required":false,"description":"The version of the extension to get. If not specified, it returns the latest version.","schema":{"type":"string","description":"The version of the extension to get. If not specified, it returns the latest version."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-extension-bits-products":{"get":{"operationId":"entertainment_twitch_get_extension_bits_products","summary":"Gets the list of Bits products that belongs to the extension.","description":"GET /bits/extensions","tags":["entertainment"],"parameters":[{"name":"should_include_all","in":"query","required":false,"description":"A Boolean value that determines whether to include disabled or expired Bits products in the response. The default is **false**.","schema":{"type":"boolean","description":"A Boolean value that determines whether to include disabled or expired Bits products in the response. The default is **false**."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-extension-bits-product":{"post":{"operationId":"entertainment_twitch_update_extension_bits_product","summary":"Adds or updates a Bits product that the extension created.","description":"PUT /bits/extensions","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-eventsub-subscriptions":{"get":{"operationId":"entertainment_twitch_get_eventsub_subscriptions","summary":"Gets a list of EventSub subscriptions that the client in the access token created.","description":"GET /eventsub/subscriptions","tags":["entertainment"],"parameters":[{"name":"status","in":"query","required":false,"description":"Filter subscriptions by its status. Possible values are: * enabled — The subscription is enabled. *…","schema":{"type":"string","enum":["enabled","webhook_callback_verification_pending","webhook_callback_verification_failed","notification_failures_exceeded","authorization_revoked","moderator_removed","user_removed","chat_user_banned","version_removed","beta_maintenance","websocket_disconnected","websocket_failed_ping_pong","websocket_received_inbound_traffic","websocket_connection_unused","websocket_internal_error","websocket_network_timeout","websocket_network_error","websocket_failed_to_reconnect","conduit_deleted"],"description":"Filter subscriptions by its status. Possible values are: * enabled — The subscription is enabled. *…"}},{"name":"type","in":"query","required":false,"description":"Filter subscriptions by subscription type. For a list of subscription types, see [Subscription…","schema":{"type":"string","description":"Filter subscriptions by subscription type. For a list of subscription types, see [Subscription…"}},{"name":"user_id","in":"query","required":false,"description":"Filter subscriptions by user ID. The response contains subscriptions where this ID matches a user ID that you specified in the…","schema":{"type":"string","description":"Filter subscriptions by user ID. The response contains subscriptions where this ID matches a user ID that you specified in the…"}},{"name":"subscription_id","in":"query","required":false,"description":"Returns an array with the subscription matching the ID (as long as it is owned by the client making the request), or an empty array if…","schema":{"type":"string","description":"Returns an array with the subscription matching the ID (as long as it is owned by the client making the request), or an empty array if…"}},{"name":"conduit_id","in":"query","required":false,"description":"Filter subscriptions by [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) ID.","schema":{"type":"string","description":"Filter subscriptions by [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) ID."}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The `pagination` object in the response contains the cursor’s value.","schema":{"type":"string","description":"The cursor used to get the next page of results. The `pagination` object in the response contains the cursor’s value."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/create-eventsub-subscription":{"post":{"operationId":"entertainment_twitch_create_eventsub_subscription","summary":"Creates an EventSub subscription.","description":"POST /eventsub/subscriptions","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/delete-eventsub-subscription":{"post":{"operationId":"entertainment_twitch_delete_eventsub_subscription","summary":"Deletes an EventSub subscription.","description":"DELETE /eventsub/subscriptions","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the subscription to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-top-games":{"get":{"operationId":"entertainment_twitch_get_top_games","summary":"Gets information about all broadcasts on Twitch.","description":"GET /games/top","tags":["entertainment"],"parameters":[{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…","schema":{"type":"integer","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}},{"name":"before","in":"query","required":false,"description":"The cursor used to get the previous page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the previous page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-games":{"get":{"operationId":"entertainment_twitch_get_games","summary":"Gets information about specified games.","description":"GET /games","tags":["entertainment"],"parameters":[{"name":"id","in":"query","required":false,"description":"The ID of the category or game to get. Include this parameter for each category or game you want to get. For example, `&id=1234&id=5678`.…","schema":{"type":"array","description":"The ID of the category or game to get. Include this parameter for each category or game you want to get. For example, `&id=1234&id=5678`.…"}},{"name":"name","in":"query","required":false,"description":"The name of the category or game to get. The name must exactly match the category’s or game’s title. Include this parameter for each…","schema":{"type":"array","description":"The name of the category or game to get. The name must exactly match the category’s or game’s title. Include this parameter for each…"}},{"name":"igdb_id","in":"query","required":false,"description":"The [IGDB](https://www.igdb.com/) ID of the game to get. Include this parameter for each game you want to get. For example,…","schema":{"type":"array","description":"The [IGDB](https://www.igdb.com/) ID of the game to get. Include this parameter for each game you want to get. For example,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-creator-goals":{"get":{"operationId":"entertainment_twitch_get_creator_goals","summary":"Gets the broadcaster’s list of active goals.","description":"GET /goals","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster that created the goals. This ID must match the user ID in the user access token.","schema":{"type":"string","description":"The ID of the broadcaster that created the goals. This ID must match the user ID in the user access token."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-channel-guest-star-settings":{"get":{"operationId":"entertainment_twitch_get_channel_guest_star_settings","summary":"BETA Gets the channel settings for configuration of the Guest Star feature for a particular host.","description":"GET /guest_star/channel_settings","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster you want to get guest star settings for.","schema":{"type":"string","description":"The ID of the broadcaster you want to get guest star settings for."}},{"name":"moderator_id","in":"query","required":true,"description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the…","schema":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-channel-guest-star-settings":{"post":{"operationId":"entertainment_twitch_update_channel_guest_star_settings","summary":"BETA Mutates the channel settings for configuration of the Guest Star feature for a particular host.","description":"PUT /guest_star/channel_settings","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster you want to update Guest Star settings for."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-guest-star-session":{"get":{"operationId":"entertainment_twitch_get_guest_star_session","summary":"BETA Gets information about an ongoing Guest Star session for a particular channel.","description":"GET /guest_star/session","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"ID for the user hosting the Guest Star session.","schema":{"type":"string","description":"ID for the user hosting the Guest Star session."}},{"name":"moderator_id","in":"query","required":true,"description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the…","schema":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/create-guest-star-session":{"post":{"operationId":"entertainment_twitch_create_guest_star_session","summary":"BETA Programmatically creates a Guest Star session on behalf of the broadcaster.","description":"POST /guest_star/session","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster you want to create a Guest Star session for. Provided `broadcaster_id` must match the `user_id` in the auth token."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/end-guest-star-session":{"post":{"operationId":"entertainment_twitch_end_guest_star_session","summary":"BETA Programmatically ends a Guest Star session on behalf of the broadcaster.","description":"DELETE /guest_star/session","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","session_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster you want to end a Guest Star session for. Provided `broadcaster_id` must match the `user_id` in the auth token."},"session_id":{"type":"string","description":"ID for the session to end on behalf of the broadcaster."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-guest-star-invites":{"get":{"operationId":"entertainment_twitch_get_guest_star_invites","summary":"BETA Provides the caller with a list of pending invites to a Guest Star session.","description":"GET /guest_star/invites","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster running the Guest Star session.","schema":{"type":"string","description":"The ID of the broadcaster running the Guest Star session."}},{"name":"moderator_id","in":"query","required":true,"description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the `user_id` in the…","schema":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the `user_id` in the…"}},{"name":"session_id","in":"query","required":true,"description":"The session ID to query for invite status.","schema":{"type":"string","description":"The session ID to query for invite status."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/send-guest-star-invite":{"post":{"operationId":"entertainment_twitch_send_guest_star_invite","summary":"BETA Sends an invite to a specified guest on behalf of the broadcaster for a Guest Star session in progress.","description":"POST /guest_star/invites","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id","session_id","guest_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster running the Guest Star session."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the `user_id` in the…"},"session_id":{"type":"string","description":"The session ID for the invite to be sent on behalf of the broadcaster."},"guest_id":{"type":"string","description":"Twitch User ID for the guest to invite to the Guest Star session."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/delete-guest-star-invite":{"post":{"operationId":"entertainment_twitch_delete_guest_star_invite","summary":"BETA Revokes a previously sent invite for a Guest Star session.","description":"DELETE /guest_star/invites","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id","session_id","guest_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster running the Guest Star session."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the `user_id` in the…"},"session_id":{"type":"string","description":"The ID of the session for the invite to be revoked on behalf of the broadcaster."},"guest_id":{"type":"string","description":"Twitch User ID for the guest to revoke the Guest Star session invite from."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/assign-guest-star-slot":{"post":{"operationId":"entertainment_twitch_assign_guest_star_slot","summary":"BETA Allows a previously invited user to be assigned a slot within the active Guest Star session.","description":"POST /guest_star/slot","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id","session_id","guest_id","slot_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster running the Guest Star session."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the `user_id` in the…"},"session_id":{"type":"string","description":"The ID of the Guest Star session in which to assign the slot."},"guest_id":{"type":"string","description":"The Twitch User ID corresponding to the guest to assign a slot in the session. This user must already have an invite to this session, and…"},"slot_id":{"type":"string","description":"The slot assignment to give to the user. Must be a numeric identifier between “1” and “N” where N is the max number of slots for the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-guest-star-slot":{"post":{"operationId":"entertainment_twitch_update_guest_star_slot","summary":"BETA Allows a user to update the assigned slot for a particular user within the active Guest Star session.","description":"PATCH /guest_star/slot","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id","session_id","source_slot_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster running the Guest Star session."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the `user_id` in the…"},"session_id":{"type":"string","description":"The ID of the Guest Star session in which to update slot settings."},"source_slot_id":{"type":"string","description":"The slot assignment previously assigned to a user."},"destination_slot_id":{"type":"string","description":"The slot to move this user assignment to. If the destination slot is occupied, the user assigned will be swapped into `source_slot_id`."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/delete-guest-star-slot":{"post":{"operationId":"entertainment_twitch_delete_guest_star_slot","summary":"BETA Allows a caller to remove a slot assignment from a user participating in an active Guest Star session.","description":"DELETE /guest_star/slot","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id","session_id","guest_id","slot_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster running the Guest Star session."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the…"},"session_id":{"type":"string","description":"The ID of the Guest Star session in which to remove the slot assignment."},"guest_id":{"type":"string","description":"The Twitch User ID corresponding to the guest to remove from the session."},"slot_id":{"type":"string","description":"The slot ID representing the slot assignment to remove from the session."},"should_reinvite_guest":{"type":"string","description":"Flag signaling that the guest should be reinvited to the session, sending them back to the invite queue."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-guest-star-slot-settings":{"post":{"operationId":"entertainment_twitch_update_guest_star_slot_settings","summary":"BETA Allows a user to update slot settings for a particular guest within a Guest Star session.","description":"PATCH /guest_star/slot_settings","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id","session_id","slot_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster running the Guest Star session."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the…"},"session_id":{"type":"string","description":"The ID of the Guest Star session in which to update a slot’s settings."},"slot_id":{"type":"string","description":"The slot assignment that has previously been assigned to a user."},"is_audio_enabled":{"type":"boolean","description":"Flag indicating whether the slot is allowed to share their audio with the rest of the session. If false, the slot will be muted in any…"},"is_video_enabled":{"type":"boolean","description":"Flag indicating whether the slot is allowed to share their video with the rest of the session. If false, the slot will have no video…"},"is_live":{"type":"boolean","description":"Flag indicating whether the user assigned to this slot is visible/can be heard from any public subscriptions. Generally, this determines…"},"volume":{"type":"integer","description":"Value from 0-100 that controls the audio volume for shared views containing the slot."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-hype-train-status":{"get":{"operationId":"entertainment_twitch_get_hype_train_status","summary":"Gets the status of a Hype Train for the specified broadcaster.","description":"GET /hypetrain/status","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The User ID of the channel broadcaster.","schema":{"type":"string","description":"The User ID of the channel broadcaster."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/check-automod-status":{"post":{"operationId":"entertainment_twitch_check_automod_status","summary":"Checks whether AutoMod would flag the specified message for review.","description":"POST /moderation/enforcements/status","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster whose AutoMod settings and list of blocked terms are used to check the message. This ID must match the user ID…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/manage-held-automod-messages":{"post":{"operationId":"entertainment_twitch_manage_held_automod_messages","summary":"Allow or deny the message that AutoMod flagged for review.","description":"POST /moderation/automod/message","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-automod-settings":{"get":{"operationId":"entertainment_twitch_get_automod_settings","summary":"Gets the broadcaster’s AutoMod settings.","description":"GET /moderation/automod/settings","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster whose AutoMod settings you want to get.","schema":{"type":"string","description":"The ID of the broadcaster whose AutoMod settings you want to get."}},{"name":"moderator_id","in":"query","required":true,"description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the…","schema":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-automod-settings":{"post":{"operationId":"entertainment_twitch_update_automod_settings","summary":"Updates the broadcaster’s AutoMod settings.","description":"PUT /moderation/automod/settings","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster whose AutoMod settings you want to update."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-banned-users":{"get":{"operationId":"entertainment_twitch_get_banned_users","summary":"Gets all users that the broadcaster banned or put in a timeout.","description":"GET /moderation/banned","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster whose list of banned users you want to get. This ID must match the user ID in the access token.","schema":{"type":"string","description":"The ID of the broadcaster whose list of banned users you want to get. This ID must match the user ID in the access token."}},{"name":"user_id","in":"query","required":false,"description":"A list of user IDs used to filter the results. To specify more than one ID, include this parameter for each user you want to get. For…","schema":{"type":"array","description":"A list of user IDs used to filter the results. To specify more than one ID, include this parameter for each user you want to get. For…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…","schema":{"type":"integer","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}},{"name":"before","in":"query","required":false,"description":"The cursor used to get the previous page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the previous page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/ban-user":{"post":{"operationId":"entertainment_twitch_ban_user","summary":"Bans a user from participating in a broadcaster’s chat room or puts them in a timeout.","description":"POST /moderation/bans","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster whose chat room the user is being banned from."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/unban-user":{"post":{"operationId":"entertainment_twitch_unban_user","summary":"Removes the ban or timeout that was placed on the specified user.","description":"DELETE /moderation/bans","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id","user_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster whose chat room the user is banned from chatting in."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the…"},"user_id":{"type":"string","description":"The ID of the user to remove the ban or timeout from."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-unban-requests":{"get":{"operationId":"entertainment_twitch_get_unban_requests","summary":"Gets a list of unban requests for a broadcaster’s channel.","description":"GET /moderation/unban_requests","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster whose channel is receiving unban requests.","schema":{"type":"string","description":"The ID of the broadcaster whose channel is receiving unban requests."}},{"name":"moderator_id","in":"query","required":true,"description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s unban requests. This ID must match the user ID in…","schema":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s unban requests. This ID must match the user ID in…"}},{"name":"status","in":"query","required":true,"description":"Filter by a status. * pending * approved * denied * acknowledged * canceled","schema":{"type":"string","description":"Filter by a status. * pending * approved * denied * acknowledged * canceled"}},{"name":"user_id","in":"query","required":false,"description":"The ID used to filter what unban requests are returned.","schema":{"type":"string","description":"The ID used to filter what unban requests are returned."}},{"name":"after","in":"query","required":false,"description":"Cursor used to get next page of results. Pagination object in response contains cursor value.","schema":{"type":"string","description":"Cursor used to get next page of results. Pagination object in response contains cursor value."}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in response","schema":{"type":"integer","description":"The maximum number of items to return per page in response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/resolve-unban-requests":{"post":{"operationId":"entertainment_twitch_resolve_unban_requests","summary":"Resolves an unban request by approving or denying it.","description":"PATCH /moderation/unban_requests","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id","unban_request_id","status"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster whose channel is approving or denying the unban request."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s unban requests. This ID must match the user ID in…"},"unban_request_id":{"type":"string","description":"The ID of the Unban Request to resolve."},"status":{"type":"string","description":"Resolution status. * approved * denied"},"resolution_text":{"type":"string","description":"Message supplied by the unban request resolver. The message is limited to a maximum of 500 characters."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-blocked-terms":{"get":{"operationId":"entertainment_twitch_get_blocked_terms","summary":"Gets the broadcaster’s list of non-private, blocked words or phrases.","description":"GET /moderation/blocked_terms","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster whose blocked terms you’re getting.","schema":{"type":"string","description":"The ID of the broadcaster whose blocked terms you’re getting."}},{"name":"moderator_id","in":"query","required":true,"description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the…","schema":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…","schema":{"type":"integer","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value.","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/add-blocked-term":{"post":{"operationId":"entertainment_twitch_add_blocked_term","summary":"Adds a word or phrase to the broadcaster’s list of blocked terms.","description":"POST /moderation/blocked_terms","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that owns the list of blocked terms."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/remove-blocked-term":{"post":{"operationId":"entertainment_twitch_remove_blocked_term","summary":"Removes the word or phrase from the broadcaster’s list of blocked terms.","description":"DELETE /moderation/blocked_terms","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id","id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that owns the list of blocked terms."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the…"},"id":{"type":"string","description":"The ID of the blocked term to remove from the broadcaster’s list of blocked terms."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/delete-chat-messages":{"post":{"operationId":"entertainment_twitch_delete_chat_messages","summary":"Removes a single chat message or all chat messages from the broadcaster’s chat room.","description":"DELETE /moderation/chat","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that owns the chat room to remove messages from."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID in the…"},"message_id":{"type":"string","description":"The ID of the message to remove. The `id` tag in the [PRIVMSG](https://dev.twitch.tv/docs/irc/tags#privmsg-tags) tag contains the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-moderated-channels":{"get":{"operationId":"entertainment_twitch_get_moderated_channels","summary":"Gets a list of channels that the specified user has moderator privileges in.","description":"GET /moderation/channels","tags":["entertainment"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"A user’s ID. Returns the list of channels that this user has moderator privileges in. This ID must match the user ID in the user OAuth token","schema":{"type":"string","description":"A user’s ID. Returns the list of channels that this user has moderator privileges in. This ID must match the user ID in the user OAuth token"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value.","schema":{"type":"string","description":"The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value."}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. Minimum page size is 1 item per page and the maximum is 100\\. The default…","schema":{"type":"integer","description":"The maximum number of items to return per page in the response. Minimum page size is 1 item per page and the maximum is 100\\. The default…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-moderators":{"get":{"operationId":"entertainment_twitch_get_moderators","summary":"Gets all users allowed to moderate the broadcaster’s chat room.","description":"GET /moderation/moderators","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster whose list of moderators you want to get. This ID must match the user ID in the access token.","schema":{"type":"string","description":"The ID of the broadcaster whose list of moderators you want to get. This ID must match the user ID in the access token."}},{"name":"user_id","in":"query","required":false,"description":"A list of user IDs used to filter the results. To specify more than one ID, include this parameter for each moderator you want to get. For…","schema":{"type":"array","description":"A list of user IDs used to filter the results. To specify more than one ID, include this parameter for each moderator you want to get. For…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…","schema":{"type":"string","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/add-channel-moderator":{"post":{"operationId":"entertainment_twitch_add_channel_moderator","summary":"Adds a moderator to the broadcaster’s chat room.","description":"POST /moderation/moderators","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","user_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that owns the chat room. This ID must match the user ID in the access token."},"user_id":{"type":"string","description":"The ID of the user to add as a moderator in the broadcaster’s chat room."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/remove-channel-moderator":{"post":{"operationId":"entertainment_twitch_remove_channel_moderator","summary":"Removes a moderator from the broadcaster’s chat room.","description":"DELETE /moderation/moderators","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","user_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that owns the chat room. This ID must match the user ID in the access token."},"user_id":{"type":"string","description":"The ID of the user to remove as a moderator from the broadcaster’s chat room."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-vips":{"get":{"operationId":"entertainment_twitch_get_vips","summary":"Gets a list of the broadcaster’s VIPs.","description":"GET /channels/vips","tags":["entertainment"],"parameters":[{"name":"user_id","in":"query","required":false,"description":"Filters the list for specific VIPs. To specify more than one user, include the _user\\_id_ parameter for each user to get. For example,…","schema":{"type":"array","description":"Filters the list for specific VIPs. To specify more than one user, include the _user\\_id_ parameter for each user to get. For example,…"}},{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster whose list of VIPs you want to get. This ID must match the user ID in the access token.","schema":{"type":"string","description":"The ID of the broadcaster whose list of VIPs you want to get. This ID must match the user ID in the access token."}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100\\. The…","schema":{"type":"integer","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100\\. The…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/add-channel-vip":{"post":{"operationId":"entertainment_twitch_add_channel_vip","summary":"Adds the specified user as a VIP in the broadcaster’s channel.","description":"POST /channels/vips","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id","broadcaster_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user to give VIP status to."},"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that’s adding the user as a VIP. This ID must match the user ID in the access token."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/remove-channel-vip":{"post":{"operationId":"entertainment_twitch_remove_channel_vip","summary":"Removes the specified user as a VIP in the broadcaster’s channel.","description":"DELETE /channels/vips","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["user_id","broadcaster_id"],"properties":{"user_id":{"type":"string","description":"The ID of the user to remove VIP status from."},"broadcaster_id":{"type":"string","description":"The ID of the broadcaster who owns the channel where the user has VIP status."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-shield-mode-status":{"get":{"operationId":"entertainment_twitch_get_shield_mode_status","summary":"Gets the broadcaster’s Shield Mode activation status.","description":"GET /moderation/shield_mode","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster whose Shield Mode activation status you want to get.","schema":{"type":"string","description":"The ID of the broadcaster whose Shield Mode activation status you want to get."}},{"name":"moderator_id","in":"query","required":true,"description":"The ID of the broadcaster or a user that is one of the broadcaster’s moderators. This ID must match the user ID in the access token.","schema":{"type":"string","description":"The ID of the broadcaster or a user that is one of the broadcaster’s moderators. This ID must match the user ID in the access token."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-shield-mode-status":{"post":{"operationId":"entertainment_twitch_update_shield_mode_status","summary":"Activates or deactivates the broadcaster’s Shield Mode.","description":"PUT /moderation/shield_mode","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster whose Shield Mode you want to activate or deactivate."},"moderator_id":{"type":"string","description":"The ID of the broadcaster or a user that is one of the broadcaster’s moderators. This ID must match the user ID in the access token."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/warn-chat-user":{"post":{"operationId":"entertainment_twitch_warn_chat_user","summary":"Warns a user in the specified broadcaster’s chat room, preventing them from chat interaction until the…","description":"POST /moderation/warnings","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the channel in which the warning will take effect."},"moderator_id":{"type":"string","description":"The ID of the twitch user who requested the warning."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/add-suspicious-status-to-chat-user":{"post":{"operationId":"entertainment_twitch_add_suspicious_status_to_chat_user","summary":"NEW Adds a suspicious user status to a chatter on the broadcaster’s channel.","description":"POST /moderation/suspicious_users","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id"],"properties":{"broadcaster_id":{"type":"string","description":"The user ID of the broadcaster, indicating the channel where the status is being applied."},"moderator_id":{"type":"string","description":"The user ID of the moderator who is applying the status."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/remove-suspicious-status-from-chat-user":{"post":{"operationId":"entertainment_twitch_remove_suspicious_status_from_chat_user","summary":"NEW Remove a suspicious user status from a chatter on broadcaster’s channel.","description":"DELETE /moderation/suspicious_users","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","moderator_id","user_id"],"properties":{"broadcaster_id":{"type":"string","description":"The user ID of the broadcaster, indicating the channel where the status is being removed."},"moderator_id":{"type":"string","description":"The user ID of the moderator who is removing the status."},"user_id":{"type":"string","description":"The ID of the user having the suspicious status removed."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-polls":{"get":{"operationId":"entertainment_twitch_get_polls","summary":"Gets a list of polls that the broadcaster created.","description":"GET /polls","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster that created the polls. This ID must match the user ID in the user access token.","schema":{"type":"string","description":"The ID of the broadcaster that created the polls. This ID must match the user ID in the user access token."}},{"name":"id","in":"query","required":false,"description":"A list of IDs that identify the polls to return. To specify more than one ID, include this parameter for each poll you want to get. For…","schema":{"type":"array","description":"A list of IDs that identify the polls to return. To specify more than one ID, include this parameter for each poll you want to get. For…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 20 items per…","schema":{"type":"string","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 20 items per…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/create-poll":{"post":{"operationId":"entertainment_twitch_create_poll","summary":"Creates a poll that viewers in the broadcaster’s channel can vote on.","description":"POST /polls","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/end-poll":{"post":{"operationId":"entertainment_twitch_end_poll","summary":"End an active poll.","description":"PATCH /polls","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-predictions":{"get":{"operationId":"entertainment_twitch_get_predictions","summary":"Gets a list of Channel Points Predictions that the broadcaster created.","description":"GET /predictions","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster whose predictions you want to get. This ID must match the user ID in the user access token.","schema":{"type":"string","description":"The ID of the broadcaster whose predictions you want to get. This ID must match the user ID in the user access token."}},{"name":"id","in":"query","required":false,"description":"The ID of the prediction to get. To specify more than one ID, include this parameter for each prediction you want to get. For example,…","schema":{"type":"array","description":"The ID of the prediction to get. To specify more than one ID, include this parameter for each prediction you want to get. For example,…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 25 items per…","schema":{"type":"string","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 25 items per…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/create-prediction":{"post":{"operationId":"entertainment_twitch_create_prediction","summary":"Create a Channel Points Prediction.","description":"POST /predictions","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/end-prediction":{"post":{"operationId":"entertainment_twitch_end_prediction","summary":"Locks, resolves, or cancels a Channel Points Prediction.","description":"PATCH /predictions","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/start-a-raid":{"post":{"operationId":"entertainment_twitch_start_a_raid","summary":"Raid another channel by sending the broadcaster’s viewers to the targeted channel.","description":"POST /raids","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"from_broadcaster_id":{"type":"string","description":"The ID of the broadcaster that’s sending the raiding party. This ID must match the user ID in the user access token."},"to_broadcaster_id":{"type":"string","description":"The ID of the broadcaster to raid."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/cancel-a-raid":{"post":{"operationId":"entertainment_twitch_cancel_a_raid","summary":"Cancel a pending raid.","description":"DELETE /raids","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that initiated the raid. This ID must match the user ID in the user access token."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-channel-stream-schedule":{"get":{"operationId":"entertainment_twitch_get_channel_stream_schedule","summary":"Gets the broadcaster’s streaming schedule.","description":"GET /schedule","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster that owns the streaming schedule you want to get.","schema":{"type":"string","description":"The ID of the broadcaster that owns the streaming schedule you want to get."}},{"name":"id","in":"query","required":false,"description":"The ID of the scheduled segment to return. To specify more than one segment, include the ID of each segment you want to get. For example,…","schema":{"type":"array","description":"The ID of the scheduled segment to return. To specify more than one segment, include the ID of each segment you want to get. For example,…"}},{"name":"start_time","in":"query","required":false,"description":"The UTC date and time that identifies when in the broadcaster’s schedule to start returning segments. If not specified, the request…","schema":{"type":"string","description":"The UTC date and time that identifies when in the broadcaster’s schedule to start returning segments. If not specified, the request…"}},{"name":"utc_offset","in":"query","required":false,"description":"Not supported.","schema":{"type":"string","description":"Not supported."}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 25 items per…","schema":{"type":"integer","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 25 items per…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-channel-icalendar":{"get":{"operationId":"entertainment_twitch_get_channel_icalendar","summary":"Gets the broadcaster’s streaming schedule as an iCalendar.","description":"GET /schedule/icalendar","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster that owns the streaming schedule you want to get.","schema":{"type":"string","description":"The ID of the broadcaster that owns the streaming schedule you want to get."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-channel-stream-schedule":{"post":{"operationId":"entertainment_twitch_update_channel_stream_schedule","summary":"Updates the broadcaster’s schedule settings, such as scheduling a vacation.","description":"PATCH /schedule/settings","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster whose schedule settings you want to update. The ID must match the user ID in the user access token."},"is_vacation_enabled":{"type":"boolean","description":"A Boolean value that indicates whether the broadcaster has scheduled a vacation. Set to **true** to enable Vacation Mode and add vacation…"},"vacation_start_time":{"type":"string","description":"The UTC date and time of when the broadcaster’s vacation starts. Specify the date and time in RFC3339 format (for example,…"},"vacation_end_time":{"type":"string","description":"The UTC date and time of when the broadcaster’s vacation ends. Specify the date and time in RFC3339 format (for example,…"},"timezone":{"type":"string","description":"The time zone that the broadcaster broadcasts from. Specify the time zone using [IANA time zone database](https://www.iana.org/time-zones)…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/create-channel-stream-schedule-segment":{"post":{"operationId":"entertainment_twitch_create_channel_stream_schedule_segment","summary":"Adds a single or recurring broadcast to the broadcaster’s streaming schedule.","description":"POST /schedule/segment","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that owns the schedule to add the broadcast segment to. This ID must match the user ID in the user access token."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-channel-stream-schedule-segment":{"post":{"operationId":"entertainment_twitch_update_channel_stream_schedule_segment","summary":"Updates a scheduled broadcast segment.","description":"PATCH /schedule/segment","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster who owns the broadcast segment to update. This ID must match the user ID in the user access token."},"id":{"type":"string","description":"The ID of the broadcast segment to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/delete-channel-stream-schedule-segment":{"post":{"operationId":"entertainment_twitch_delete_channel_stream_schedule_segment","summary":"Deletes a broadcast from the broadcaster’s streaming schedule.","description":"DELETE /schedule/segment","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcaster_id","id"],"properties":{"broadcaster_id":{"type":"string","description":"The ID of the broadcaster that owns the streaming schedule. This ID must match the user ID in the user access token."},"id":{"type":"string","description":"The ID of the broadcast segment to remove."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/search-categories":{"get":{"operationId":"entertainment_twitch_search_categories","summary":"Gets the games or categories that match the specified query.","description":"GET /search/categories","tags":["entertainment"],"parameters":[{"name":"query","in":"query","required":true,"description":"The URI-encoded search string. For example, encode _#archery_ as `%23archery` and search strings like _angel of death_ as…","schema":{"type":"string","description":"The URI-encoded search string. For example, encode _#archery_ as `%23archery` and search strings like _angel of death_ as…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…","schema":{"type":"integer","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/search-channels":{"get":{"operationId":"entertainment_twitch_search_channels","summary":"Gets the channels that match the specified query and have streamed content within the past 6 months.","description":"GET /search/channels","tags":["entertainment"],"parameters":[{"name":"query","in":"query","required":true,"description":"The URI-encoded search string. For example, encode search strings like _angel of death_ as `angel%20of%20death`.","schema":{"type":"string","description":"The URI-encoded search string. For example, encode search strings like _angel of death_ as `angel%20of%20death`."}},{"name":"live_only","in":"query","required":false,"description":"A Boolean value that determines whether the response includes only channels that are currently streaming live. Set to **true** to get only…","schema":{"type":"boolean","description":"A Boolean value that determines whether the response includes only channels that are currently streaming live. Set to **true** to get only…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…","schema":{"type":"integer","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-stream-key":{"get":{"operationId":"entertainment_twitch_get_stream_key","summary":"Gets the channel’s stream key.","description":"GET /streams/key","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster that owns the channel. The ID must match the user ID in the access token.","schema":{"type":"string","description":"The ID of the broadcaster that owns the channel. The ID must match the user ID in the access token."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-streams":{"get":{"operationId":"entertainment_twitch_get_streams","summary":"Gets a list of all streams.","description":"GET /streams","tags":["entertainment"],"parameters":[{"name":"user_id","in":"query","required":false,"description":"A user ID used to filter the list of streams. Returns only the streams of those users that are broadcasting. You may specify a maximum of…","schema":{"type":"array","description":"A user ID used to filter the list of streams. Returns only the streams of those users that are broadcasting. You may specify a maximum of…"}},{"name":"user_login","in":"query","required":false,"description":"A user login name used to filter the list of streams. Returns only the streams of those users that are broadcasting. You may specify a…","schema":{"type":"array","description":"A user login name used to filter the list of streams. Returns only the streams of those users that are broadcasting. You may specify a…"}},{"name":"game_id","in":"query","required":false,"description":"A game (category) ID used to filter the list of streams. Returns only the streams that are broadcasting the game (category). You may…","schema":{"type":"array","description":"A game (category) ID used to filter the list of streams. Returns only the streams that are broadcasting the game (category). You may…"}},{"name":"type","in":"query","required":false,"description":"The type of stream to filter the list of streams by. Possible values are: * all * live The default is _all_.","schema":{"type":"string","enum":["all","live"],"description":"The type of stream to filter the list of streams by. Possible values are: * all * live The default is _all_."}},{"name":"language","in":"query","required":false,"description":"A language code used to filter the list of streams. Returns only streams that broadcast in the specified language. Specify the language…","schema":{"type":"array","description":"A language code used to filter the list of streams. Returns only streams that broadcast in the specified language. Specify the language…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…","schema":{"type":"integer","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…"}},{"name":"before","in":"query","required":false,"description":"The cursor used to get the previous page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the previous page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-followed-streams":{"get":{"operationId":"entertainment_twitch_get_followed_streams","summary":"Gets the list of broadcasters that the user follows and that are streaming live.","description":"GET /streams/followed","tags":["entertainment"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"The ID of the user whose list of followed streams you want to get. This ID must match the user ID in the access token.","schema":{"type":"string","description":"The ID of the user whose list of followed streams you want to get. This ID must match the user ID in the access token."}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…","schema":{"type":"integer","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-stream-markers":{"get":{"operationId":"entertainment_twitch_get_stream_markers","summary":"Gets a list of markers from the user’s most recent stream or from the specified VOD/video.","description":"GET /streams/markers","tags":["entertainment"],"parameters":[{"name":"user_id","in":"query","required":false,"description":"A user ID. The request returns the markers from this user’s most recent video. This ID must match the user ID in the access token or the…","schema":{"type":"string","description":"A user ID. The request returns the markers from this user’s most recent video. This ID must match the user ID in the access token or the…"}},{"name":"video_id","in":"query","required":false,"description":"A video on demand (VOD)/video ID. The request returns the markers from this VOD/video. The user in the access token must own the video or…","schema":{"type":"string","description":"A video on demand (VOD)/video ID. The request returns the markers from this VOD/video. The user in the access token must own the video or…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…","schema":{"type":"string","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…"}},{"name":"before","in":"query","required":false,"description":"The cursor used to get the previous page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the previous page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/create-stream-marker":{"post":{"operationId":"entertainment_twitch_create_stream_marker","summary":"Adds a marker to a live stream.","description":"POST /streams/markers","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-broadcaster-subscriptions":{"get":{"operationId":"entertainment_twitch_get_broadcaster_subscriptions","summary":"Gets a list of users that subscribe to the specified broadcaster.","description":"GET /subscriptions","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The broadcaster’s ID. This ID must match the user ID in the access token.","schema":{"type":"string","description":"The broadcaster’s ID. This ID must match the user ID in the access token."}},{"name":"user_id","in":"query","required":false,"description":"Filters the list to include only the specified subscribers. To specify more than one subscriber, include this parameter for each…","schema":{"type":"array","description":"Filters the list to include only the specified subscribers. To specify more than one subscriber, include this parameter for each…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…","schema":{"type":"string","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100 items per…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. Do not specify if you set the _user\\_id_ query parameter. The **Pagination** object in…","schema":{"type":"string","description":"The cursor used to get the next page of results. Do not specify if you set the _user\\_id_ query parameter. The **Pagination** object in…"}},{"name":"before","in":"query","required":false,"description":"The cursor used to get the previous page of results. Do not specify if you set the _user\\_id_ query parameter. The **Pagination** object…","schema":{"type":"string","description":"The cursor used to get the previous page of results. Do not specify if you set the _user\\_id_ query parameter. The **Pagination** object…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/check-user-subscription":{"get":{"operationId":"entertainment_twitch_check_user_subscription","summary":"Checks whether the user subscribes to the broadcaster’s channel.","description":"GET /subscriptions/user","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of a partner or affiliate broadcaster.","schema":{"type":"string","description":"The ID of a partner or affiliate broadcaster."}},{"name":"user_id","in":"query","required":true,"description":"The ID of the user that you’re checking to see whether they subscribe to the broadcaster in _broadcaster\\_id_. This ID must match the user…","schema":{"type":"string","description":"The ID of the user that you’re checking to see whether they subscribe to the broadcaster in _broadcaster\\_id_. This ID must match the user…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-channel-teams":{"get":{"operationId":"entertainment_twitch_get_channel_teams","summary":"Gets the list of Twitch teams that the broadcaster is a member of.","description":"GET /teams/channel","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster whose teams you want to get.","schema":{"type":"string","description":"The ID of the broadcaster whose teams you want to get."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-teams":{"get":{"operationId":"entertainment_twitch_get_teams","summary":"Gets information about the specified Twitch team.","description":"GET /teams","tags":["entertainment"],"parameters":[{"name":"name","in":"query","required":false,"description":"The name of the team to get. This parameter and the _id_ parameter are mutually exclusive; you must specify the team’s name or ID but not…","schema":{"type":"string","description":"The name of the team to get. This parameter and the _id_ parameter are mutually exclusive; you must specify the team’s name or ID but not…"}},{"name":"id","in":"query","required":false,"description":"The ID of the team to get. This parameter and the _name_ parameter are mutually exclusive; you must specify the team’s name or ID but not…","schema":{"type":"string","description":"The ID of the team to get. This parameter and the _name_ parameter are mutually exclusive; you must specify the team’s name or ID but not…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-users":{"get":{"operationId":"entertainment_twitch_get_users","summary":"Gets information about one or more users.","description":"GET /users","tags":["entertainment"],"parameters":[{"name":"id","in":"query","required":false,"description":"The ID of the user to get. To specify more than one user, include the _id_ parameter for each user to get. For example, `id=1234&id=5678`.…","schema":{"type":"array","description":"The ID of the user to get. To specify more than one user, include the _id_ parameter for each user to get. For example, `id=1234&id=5678`.…"}},{"name":"login","in":"query","required":false,"description":"The login name of the user to get. To specify more than one user, include the _login_ parameter for each user to get. For example,…","schema":{"type":"array","description":"The login name of the user to get. To specify more than one user, include the _login_ parameter for each user to get. For example,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-user":{"post":{"operationId":"entertainment_twitch_update_user","summary":"Updates the user’s information.","description":"PUT /users","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"The string to update the channel’s description to. The description is limited to a maximum of 300 characters. To remove the description,…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-authorization-by-user":{"get":{"operationId":"entertainment_twitch_get_authorization_by_user","summary":"NEW Gets the authorization scopes that the specified user has granted the application.","description":"GET /authorization/users","tags":["entertainment"],"parameters":[{"name":"user_id","in":"query","required":true,"description":"The ID of the user(s) you want to check authorization for. To specify more than one user, include the user\\_id parameter for each user to…","schema":{"type":"array","description":"The ID of the user(s) you want to check authorization for. To specify more than one user, include the user\\_id parameter for each user to…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-user-block-list":{"get":{"operationId":"entertainment_twitch_get_user_block_list","summary":"Gets the list of users that the broadcaster has blocked.","description":"GET /users/blocks","tags":["entertainment"],"parameters":[{"name":"broadcaster_id","in":"query","required":true,"description":"The ID of the broadcaster whose list of blocked users you want to get.","schema":{"type":"string","description":"The ID of the broadcaster whose list of blocked users you want to get."}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100\\. The…","schema":{"type":"integer","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100\\. The…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/block-user":{"post":{"operationId":"entertainment_twitch_block_user","summary":"Blocks the specified user from interacting with or having contact with the broadcaster.","description":"PUT /users/blocks","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["target_user_id"],"properties":{"target_user_id":{"type":"string","description":"The ID of the user to block. The API ignores the request if the broadcaster has already blocked the user."},"source_context":{"type":"string","enum":["chat","whisper"],"description":"The location where the harassment took place that is causing the brodcaster to block the user. Possible values are: * chat * whisper ."},"reason":{"type":"string","enum":["harassment","spam","other"],"description":"The reason that the broadcaster is blocking the user. Possible values are: * harassment * spam * other"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/unblock-user":{"post":{"operationId":"entertainment_twitch_unblock_user","summary":"Removes the user from the broadcaster’s list of blocked users.","description":"DELETE /users/blocks","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["target_user_id"],"properties":{"target_user_id":{"type":"string","description":"The ID of the user to remove from the broadcaster’s list of blocked users. The API ignores the request if the broadcaster hasn’t blocked…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-user-extensions":{"get":{"operationId":"entertainment_twitch_get_user_extensions","summary":"Gets a list of all extensions (both active and inactive) that the broadcaster has installed.","description":"GET /users/extensions/list","tags":["entertainment"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-user-active-extensions":{"get":{"operationId":"entertainment_twitch_get_user_active_extensions","summary":"Gets the active extensions that the broadcaster has installed for each configuration.","description":"GET /users/extensions","tags":["entertainment"],"parameters":[{"name":"user_id","in":"query","required":false,"description":"The ID of the broadcaster whose active extensions you want to get. This parameter is required if you specify an app access token and is…","schema":{"type":"string","description":"The ID of the broadcaster whose active extensions you want to get. This parameter is required if you specify an app access token and is…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/update-user-extensions":{"post":{"operationId":"entertainment_twitch_update_user_extensions","summary":"Updates an installed extension’s information.","description":"PUT /users/extensions","tags":["entertainment"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/get-videos":{"get":{"operationId":"entertainment_twitch_get_videos","summary":"Gets information about one or more published videos.","description":"GET /videos","tags":["entertainment"],"parameters":[{"name":"id","in":"query","required":false,"description":"A list of IDs that identify the videos you want to get. To get more than one video, include this parameter for each video you want to get.…","schema":{"type":"array","description":"A list of IDs that identify the videos you want to get. To get more than one video, include this parameter for each video you want to get.…"}},{"name":"user_id","in":"query","required":false,"description":"The ID of the user whose list of videos you want to get. The _id_, _user\\_id_, and _game\\_id_ parameters are mutually exclusive.","schema":{"type":"string","description":"The ID of the user whose list of videos you want to get. The _id_, _user\\_id_, and _game\\_id_ parameters are mutually exclusive."}},{"name":"game_id","in":"query","required":false,"description":"A category or game ID. The response contains a maximum of 500 videos that show this content. To get category/game IDs, use the [Search…","schema":{"type":"string","description":"A category or game ID. The response contains a maximum of 500 videos that show this content. To get category/game IDs, use the [Search…"}},{"name":"language","in":"query","required":false,"description":"A filter used to filter the list of videos by the language that the video owner broadcasts in. For example, to get videos that were…","schema":{"type":"string","description":"A filter used to filter the list of videos by the language that the video owner broadcasts in. For example, to get videos that were…"}},{"name":"period","in":"query","required":false,"description":"A filter used to filter the list of videos by when they were published. For example, videos published in the last week. Possible values…","schema":{"type":"string","enum":["all","day","month","week"],"description":"A filter used to filter the list of videos by when they were published. For example, videos published in the last week. Possible values…"}},{"name":"sort","in":"query","required":false,"description":"The order to sort the returned videos in. Possible values are: * time — Sort the results in descending order by when they were created…","schema":{"type":"string","enum":["time","trending","views"],"description":"The order to sort the returned videos in. Possible values are: * time — Sort the results in descending order by when they were created…"}},{"name":"type","in":"query","required":false,"description":"A filter used to filter the list of videos by the video's type. Possible case-sensitive values are: * all * archive — On-demand videos…","schema":{"type":"string","enum":["all","archive","highlight","upload"],"description":"A filter used to filter the list of videos by the video's type. Possible case-sensitive values are: * all * archive — On-demand videos…"}},{"name":"first","in":"query","required":false,"description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100\\. The…","schema":{"type":"string","description":"The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 100\\. The…"}},{"name":"after","in":"query","required":false,"description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the next page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}},{"name":"before","in":"query","required":false,"description":"The cursor used to get the previous page of results. The **Pagination** object in the response contains the cursor’s value. [Read…","schema":{"type":"string","description":"The cursor used to get the previous page of results. The **Pagination** object in the response contains the cursor’s value. [Read…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/delete-videos":{"post":{"operationId":"entertainment_twitch_delete_videos","summary":"Deletes one or more videos.","description":"DELETE /videos","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"array","description":"The list of videos to delete. To specify more than one video, include the _id_ parameter for each video to delete. For example,…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/entertainment:twitch/send-whisper":{"post":{"operationId":"entertainment_twitch_send_whisper","summary":"Sends a whisper message to the specified user.","description":"POST /whispers","tags":["entertainment"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["from_user_id","to_user_id"],"properties":{"from_user_id":{"type":"string","description":"The ID of the user sending the whisper. This user must have a verified phone number. This ID must match the user ID in the user access…"},"to_user_id":{"type":"string","description":"The ID of the user to receive the whisper."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}