TwitchApi.Charity.GetCharityCampaign (TwitchApi v0.1.3) View Source
⛔ This module is autogenerated please do not modify manually.
Example request from twitch api docs:
descriptions:
Gets the broadcaster’s active charity campaign.
requests:
curl -X GET 'https://api.twitch.tv/helix/charity/campaigns?broadcaster_id=123456'
-H'Authorization: Bearer kpvy3cjboyptmiacwr0c19hotn5s'
-H'Client-Id: hof5gwx0su6owfn0nyan9c87zr6t'
Example response from twitch api docs:
descriptions:
responses:
{"data":[{"id":"123-abc-456-def","broadcaster_id":"123456","broadcaster_name":"SunnySideUp","broadcaster_login":"sunnysideup","charity_name":"Example name","charity_description":"Example description","charity_logo":"https://example.url/logo.png","charity_website":"https://www.example.com","current_amount":{"value":86000,"decimal_places":2,"currency":"USD"},"target_amount":{"value":1500000,"decimal_places":2,"currency":"USD"}}]}
![https://example.url/logo.png","charity_website":"https://www.example.com","current_amount":{"value":86000,"decimal_places":2,"currency":"USD"},"target_amount":{"value":1500000,"decimal_places":2,"currency":"USD"}}]}](https://example.url/logo.png%22,%22charity_website%22:%22https://www.example.com%22,%22current_amount%22:%7B%22value%22:86000,%22decimal_places%22:2,%22currency%22:%22USD%22%7D,%22target_amount%22:%7B%22value%22:1500000,%22decimal_places%22:2,%22currency%22:%22USD%22%7D%7D]%7D){kind=link}
Link to this section Summary
Types
The ID of the broadcaster that’s actively running a charity campaign.
Link to this section Types
Specs
broadcaster_id() :: %{broadcaster_id: String.t()}
The ID of the broadcaster that’s actively running a charity campaign.
Link to this section Functions
Specs
call(broadcaster_id()) :: {:ok, Finch.Response.t()} | {:error, Exception.t()}
Description:
BETA Gets information about the broadcaster’s active charity campaign.
Required authentication:
Required authorization:
Requires a user access token that includes the channel:read:charity scope. The ID in the broadcaster_id query parameter must match the user ID in the access token.