TwitchApi.ChannelPoints.UpdateRedemptionStatus (TwitchApi v0.1.2) View Source

⛔ This module is autogenerated please do not modify manually.

Example request from twitch api docs:

descriptions:

This request updates custom reward redemption status.

requests:

curl --X PATCH 'https://api.twitch.tv/helix/channel_points/custom_rewards/redemptions?broadcaster_id=274637212&reward_id=92af127c-7326-4483-a52b-b0da0be61c01&id=17fa2df1-ad76-4804-bfa5-a40ef63efe63'
-H'client-id: gx2pv4208cff0ig9ou7nk3riccffxt'
-H'Authorization: Bearer vjxv3i0l4zxru966wsnwji51tmpkj2'
-H'Content-Type: application/json'
-d'{ "status": "CANCELED" }'

Example response from twitch api docs:

descriptions:

responses:

{"data":[{"broadcaster_name":"torpedo09","broadcaster_login":"torpedo09","broadcaster_id":"274637212","id":"17fa2df1-ad76-4804-bfa5-a40ef63efe63","user_id":"274637212","user_name":"torpedo09","user_login":"torpedo09","user_input":"","status":"CANCELED","redeemed_at":"2020-07-01T18:37:32Z","reward":{"id":"92af127c-7326-4483-a52b-b0da0be61c01","title":"game analysis","prompt":"","cost":50000}}]}

Link to this section Summary

Types

Provided broadcaster_id must match the user_id in the user OAuth token.

ID of the Custom Reward Redemption to update, must match a Custom Reward Redemption on broadcaster_id’s channel. Maximum: 50.

ID of the Custom Reward the redemptions to be updated are for.

Map containing the user needed information for the fetch of the required user OAuth access token. You will be able to choose from one way or the other for fetching previously OAuth access tokens. :user_id field contains the user ID from twitch, e.g. 61425548 or "61425548" :user_name field constains the user name from twitch, e.g. "hiimkamiyuzu"

Functions

Description:

Updates the status of Custom Reward Redemption objects on a channel that are in the UNFULFILLED status.

Link to this section Types

Specs

broadcaster_id() :: %{broadcaster_id: String.t()}

Provided broadcaster_id must match the user_id in the user OAuth token.

Specs

id() :: %{id: String.t()}

ID of the Custom Reward Redemption to update, must match a Custom Reward Redemption on broadcaster_id’s channel. Maximum: 50.

Specs

reward_id() :: %{reward_id: String.t()}

ID of the Custom Reward the redemptions to be updated are for.

Specs

user_info() :: %{user_id: integer() | binary()} | %{user_name: binary()}

Map containing the user needed information for the fetch of the required user OAuth access token. You will be able to choose from one way or the other for fetching previously OAuth access tokens. :user_id field contains the user ID from twitch, e.g. 61425548 or "61425548" :user_name field constains the user name from twitch, e.g. "hiimkamiyuzu"

Link to this section Functions

Specs

call(id() | broadcaster_id() | reward_id(), user_info()) ::
  {:ok, Finch.Response.t()} | {:error, Exception.t()}

Description:

Updates the status of Custom Reward Redemption objects on a channel that are in the UNFULFILLED status.

Required authentication:

User OAuth token Required scope: channel:manage:redemptions

Required authorization: