Goals ⭐️

POST

https://wapi.wizebot.tv/api/goals/{API_KEY}/actions/{ACTION}/{ID}/{VALUE}

{#Perform a specific action on a Goals widget.#}

Request

Path Params

API_KEY

string

required

{#API key (W) of your WizeBot account.#}

Example:

ACTION

enum<string>

required

{#Action to perform#} (lock, unlock, add, remove, set, add_goal, set_goal, reset).

Allowed values:

addremovelockunlockresetsetadd_goalset_goal

Example:

add

string

required

{#Specific widget ID or 'all' for all widgets.#}

Example:

1234

VALUE

integer

required

{#Number to add/set/remove (if required by the action).#}

Example:

120

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

success

boolean

required

{#true or false, if the operation was successful.#}

code

integer

required

{#The code associated with the request.#}

change_count

integer

required

{#Number of changes applied#}

Example

{
    "success": true,
    "code": 200,
    "change_count": 1
}

Modified at 2024-09-26 18:35:50

Streamathon ⭐️

{#Emergency Mode#}