Songlist API
Version: 2.0.0
Export
/commands/{commandId}Update command
Authorization
Required scopes
streamer.command.writeWrite streamer commands
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| commandId | path | string | Yes | - |
Request Bodyrequired
application/json
Schema
Update-commandRequest
A URL to the JSON Schema for this object.
Channel to edit. Required when updating a default (D_) command as a channel admin; ignored for saved commands, which carry their own channel.
Example
{
"$schema": "https://example.com",
"action": "string",
"aliases": "string",
"altResponses": {
"accountNotConnected": "string",
"alreadyInQueue": "string",
"atRequestLimit": "string",
"cannotBump": "string",
"incorrectFormat": "string",
"liveLearnDisabled": "string",
"noInput": "string",
"noQueuedSongs": "string",
"noRequestToReplace": "string",
"noSongPlaying": "string",
"notEligible": "string",
"notEnoughTokens": "string",
"playedTooRecently": "string",
"positionNotFound": "string",
"queueFull": "string",
"queueNotClosed": "string",
"requestNotFound": "string",
"requestsDisabled": "string",
"songNotFound": "string",
"songRestricted": "string",
"songUnavailable": "string",
"songsNotFound": "string",
"songsToLearnDisabled": "string",
"tipTooLow": "string",
"tokenAmountNotExact": "string",
"tokenAmountTooLow": "string",
"tokensDisabled": "string",
"unknownError": "string",
"userBlocked": "string",
"userNotFound": "string"
},
"cooldown": 0,
"enabled": true,
"modOnly": true,
"name": "string",
"options": {
"adminQueueAdd": {
"onlyNew": true
},
"adminQueueAddLiveLearn": {
"onlyNew": true
},
"migratedFrom": "string",
"queueInsert": {
"overridePosition": 0
},
"songRequestRandom": {
"includeRecentlyPlayed": true
},
"songSearch": {
"byAttribute": true,
"onlyActive": true,
"onlyInactive": true
}
},
"response": "string",
"streamerId": 1
}Responses
200OK
application/json
Schema
BotCommandDetails
A URL to the JSON Schema for this object.
Example
{
"$schema": "https://example.com",
"action": "string",
"adminOnly": true,
"aliases": "string",
"altResponses": {
"accountNotConnected": "string",
"alreadyInQueue": "string",
"atRequestLimit": "string",
"cannotBump": "string",
"incorrectFormat": "string",
"liveLearnDisabled": "string",
"noInput": "string",
"noQueuedSongs": "string",
"noRequestToReplace": "string",
"noSongPlaying": "string",
"notEligible": "string",
"notEnoughTokens": "string",
"playedTooRecently": "string",
"positionNotFound": "string",
"queueFull": "string",
"queueNotClosed": "string",
"requestNotFound": "string",
"requestsDisabled": "string",
"songNotFound": "string",
"songRestricted": "string",
"songUnavailable": "string",
"songsNotFound": "string",
"songsToLearnDisabled": "string",
"tipTooLow": "string",
"tokenAmountNotExact": "string",
"tokenAmountTooLow": "string",
"tokensDisabled": "string",
"unknownError": "string",
"userBlocked": "string",
"userNotFound": "string"
},
"cooldown": 0,
"enabled": true,
"id": "string",
"isDefault": true,
"name": "string",
"options": {
"adminQueueAdd": {
"onlyNew": true
},
"adminQueueAddLiveLearn": {
"onlyNew": true
},
"migratedFrom": "string",
"queueInsert": {
"overridePosition": 0
},
"songRequestRandom": {
"includeRecentlyPlayed": true
},
"songSearch": {
"byAttribute": true,
"onlyActive": true,
"onlyInactive": true
}
},
"response": "string"
}400Bad Request
application/problem+json
Schema
ErrorModel
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
Array items:
ErrorDetail
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
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
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
Array items:
ErrorDetail
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
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
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
Array items:
ErrorDetail
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
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
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
Array items:
ErrorDetail
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
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
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
Array items:
ErrorDetail
Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
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"
}