Skip to content

Add a Vote Modifier

POST /vote_modifier

Adds a signed adjustment for one user. Requires an admin, backend, or broadcaster JWT.

Authorization

Send Authorization: <Twitch Extension Client ID> <Muxy JWT>. The JWT role must satisfy the endpoint requirements shown in the examples.

Parameters

Name In Required Type Constraints Description
id query no string default "default"; at most 64 characters Poll identifier. Defaults to default; global polls use an ID beginning with global.

Request body

Content type: application/json

Schema

{
  "type": "object",
  "required": [
    "user",
    "add"
  ],
  "properties": {
    "user": {
      "type": "string"
    },
    "add": {
      "type": "integer"
    }
  }
}

Example

{
  "user": "U12345",
  "add": 2
}

Responses

200 Response

Operation accepted. The current service returns an empty JSON object.

Content type: application/json

Schema
{
  "type": "object",
  "maxProperties": 0
}
Example
{}

400 Error

The request body or poll configuration is invalid.

Content type: application/json

Schema
{
  "type": "object",
  "properties": {
    "reason": {
      "type": "string"
    }
  }
}
Example
{
  "reason": "Invalid body"
}

403 Error

The JWT role is not allowed to perform this operation.

Content type: application/json

Schema
{
  "type": "object",
  "properties": {
    "reason": {
      "type": "string"
    }
  }
}
Example
{
  "reason": "role is not authorized"
}

Generated API reference

This endpoint is generated from rest-v1.yaml.