Songlist API

Version: 2.0.0

Export

Download

Download JSON Download YAML

Copy URL

patch/learn-list/config

Update learn list configuration

Authorization

Required scopes

streamer.learn-list.writeWrite to the streamer learn list

Request Bodyrequired

application/json

Schema

UpdateLearnListConfigParamsBody

$schemastring

A URL to the JSON Schema for this object.

configLearnListConfigrequired

$schemastring

A URL to the JSON Schema for this object.

addQuotaPerUserinteger

maxActiveSongsPerUserinteger

requireApprovalboolean

rewardMapobject

tokensPerVoteinteger

voteWeightsLearnListVoteWeightsrequired

defaultinteger

followerinteger

kickSubscriberinteger

twitchTier1integer

twitchTier2integer

twitchTier3integer

youtubeMemberinteger

streamerIdintegerrequired

The streamer's ID. Can be found using the GET /streamers endpoint with the streamer_name and platform parameters

Example

{
  "$schema": "https://example.com",
  "config": {
    "$schema": "https://example.com",
    "addQuotaPerUser": 0,
    "maxActiveSongsPerUser": 0,
    "requireApproval": true,
    "rewardMap": {},
    "tokensPerVote": 0,
    "voteWeights": {
      "default": 0,
      "follower": 0,
      "kickSubscriber": 0,
      "twitchTier1": 0,
      "twitchTier2": 0,
      "twitchTier3": 0,
      "youtubeMember": 0
    }
  },
  "streamerId": 1
}

Responses

200OK

application/json

Schema

LearnListConfig

$schemastring

A URL to the JSON Schema for this object.

addQuotaPerUserinteger

maxActiveSongsPerUserinteger

requireApprovalboolean

rewardMapobject

tokensPerVoteinteger

voteWeightsLearnListVoteWeightsrequired

defaultinteger

followerinteger

kickSubscriberinteger

twitchTier1integer

twitchTier2integer

twitchTier3integer

youtubeMemberinteger

Example

{
  "$schema": "https://example.com",
  "addQuotaPerUser": 0,
  "maxActiveSongsPerUser": 0,
  "requireApproval": true,
  "rewardMap": {},
  "tokensPerVote": 0,
  "voteWeights": {
    "default": 0,
    "follower": 0,
    "kickSubscriber": 0,
    "twitchTier1": 0,
    "twitchTier2": 0,
    "twitchTier3": 0,
    "youtubeMember": 0
  }
}

400Bad Request

application/problem+json

Schema

ErrorModel

$schemastring

A URL to the JSON Schema for this object.

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[]

Optional list of individual error details

Array items:

ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueunknown

The value at the given location

instancestring

A URI reference that identifies the specific occurrence of the problem.

statusinteger

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring

A URI reference to human-readable documentation for the error.

Example

{
  "$schema": "https://example.com",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

401Unauthorized

application/problem+json

Schema

ErrorModel

$schemastring

A URL to the JSON Schema for this object.

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[]

Optional list of individual error details

Array items:

ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueunknown

The value at the given location

instancestring

A URI reference that identifies the specific occurrence of the problem.

statusinteger

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring

A URI reference to human-readable documentation for the error.

Example

{
  "$schema": "https://example.com",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

403Forbidden

application/problem+json

Schema

ErrorModel

$schemastring

A URL to the JSON Schema for this object.

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[]

Optional list of individual error details

Array items:

ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueunknown

The value at the given location

instancestring

A URI reference that identifies the specific occurrence of the problem.

statusinteger

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring

A URI reference to human-readable documentation for the error.

Example

{
  "$schema": "https://example.com",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

404Not Found

application/problem+json

Schema

ErrorModel

$schemastring

A URL to the JSON Schema for this object.

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[]

Optional list of individual error details

Array items:

ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueunknown

The value at the given location

instancestring

A URI reference that identifies the specific occurrence of the problem.

statusinteger

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring

A URI reference to human-readable documentation for the error.

Example

{
  "$schema": "https://example.com",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

422Unprocessable Entity

application/problem+json

Schema

ErrorModel

$schemastring

A URL to the JSON Schema for this object.

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[]

Optional list of individual error details

Array items:

ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueunknown

The value at the given location

instancestring

A URI reference that identifies the specific occurrence of the problem.

statusinteger

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring

A URI reference to human-readable documentation for the error.

Example

{
  "$schema": "https://example.com",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}

500Internal Server Error

application/problem+json

Schema

ErrorModel

$schemastring

A URL to the JSON Schema for this object.

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[]

Optional list of individual error details

Array items:

ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueunknown

The value at the given location

instancestring

A URI reference that identifies the specific occurrence of the problem.

statusinteger

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring

A URI reference to human-readable documentation for the error.

Example

{
  "$schema": "https://example.com",
  "detail": "string",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com",
  "status": 0,
  "title": "string",
  "type": "about:blank"
}