{#Virtual currency#} - REMOVE ⭐️

POSThttps://wapi.wizebot.tv/api/currency/{API_KEY}/action/remove/{VIEWER_IDENTIFIER}/{ACTION_VALUE}/{FORCE}

{#Deletion of a value on the virtual currency account of the viewers.#}
{#By default, an error is returned ('error_code': 'insufficient_funds') if the viewer does not have the amount on his account.#}

Request

Path Params

API_KEY

string

required

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

Example:

VIEWER_IDENTIFIER

string

required

{#Name of the viewer or identifier of the platform (digital) of the viewer.#}

Example:

Dere011

ACTION_VALUE

string

required

{#Value to be withdrawn.#}

Example:

1000

FORCE

integer

required

{#Force the deletion of the sum even if the viewer does not have the required amount.#}
{#Possible values: 0 (no) - 1 (yes)#}

Example:

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

success

boolean

required

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

user

object

required

{#Information (id, name) of target user.#}

user_id

string

required

{#Viewer ID.#}

user_name

string

required

{#Viewer Name.#}

action_success

boolean

deprecated

code

integer

required

{#The code associated with the request.#}

cache_timestamps

integer

required

{#The timestamps of caching.#}

{
  "success": true,
  "user": {
    "user_id": "28294141",
    "user_name": "dere011"
  },
  "action_success": true,
  "code": 200,
  "cache_timestamps": 1714789065
}

Last modified: 7 months ago