TwitchApi.Entitlements.UpdateDropsEntitlements (TwitchApi v0.1.2) View Source

⛔ This module is autogenerated please do not modify manually.

Example request from twitch api docs:

descriptions:

requests:

curl -H PATCH 'helix/entitlements/drops'
-H'Authorization: Bearer cfabdegwdoklmawdzdo98xt2fo512y'
-H'Client-Id: uo6dggojyb8d6soh92zknwmi5ej1q2'
-H'Content-Type: application/json'
-d'{ "fulfillment_status": "FULFILLED", "entitlement_ids": [

"fb78259e-fb81-4d1b-8333-34a06ffc24c0",
"862750a5-265e-4ab6-9f0a-c64df3d54dd0",
"d8879baa-3966-4d10-8856-15fdd62cce02",
"9a290126-7e3b-4f66-a9ae-551537893b65"

] }'

Example response from twitch api docs:

descriptions:

responses:

{"data":[{"status":"SUCCESS","ids":["fb78259e-fb81-4d1b-8333-34a06ffc24c0","862750a5-265e-4ab6-9f0a-c64df3d54dd0"]},{"status":"UNAUTHORIZED","ids":["d8879baa-3966-4d10-8856-15fdd62cce02"]},{"status":"UPDATE_FAILED","ids":["9a290126-7e3b-4f66-a9ae-551537893b65"]}]}

Link to this section Summary

Types

An array of unique identifiers of the entitlements to update.Maximum: 100.

A fulfillment status. Valid values are "CLAIMED" or "FULFILLED".

Functions

Description:

Updates the fulfillment status on a set of Drops entitlements, specified by their entitlement IDs.

Link to this section Types

Specs

entitlement_ids() :: %{entitlement_ids: list()}

An array of unique identifiers of the entitlements to update.Maximum: 100.

Specs

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

A fulfillment status. Valid values are "CLAIMED" or "FULFILLED".

Link to this section Functions

Specs

call(entitlement_ids() | fulfillment_status()) ::
  {:ok, Finch.Response.t()} | {:error, Exception.t()}

Description:

Updates the fulfillment status on a set of Drops entitlements, specified by their entitlement IDs.

Required authentication:

User OAuth Token or App Access Token

Required authorization:

The client ID associated with the access token must have ownership of the game: Client ID > Organization ID > Game ID