POST Moderate users

Set a global user ban

userid : required The applicaiton provided userid of the user to ban applyeffect : required true or false.

POST /api/v3/{appid}/user/users/{userid}/ban

userid: (required) The applicaiton provided userid of the user to ban
applyeffect: (required) true or false. If true, user will be set to banned state. If false, will be set to non-banned state.
expireseconds: (optional) if not specified, the ban is permanent until user is restored. If specified, then the ban will be temporarily applied for the specified number of seconds.

Request

Parameters

Values in the path and query string.

appid path

string TalkLabs ID required

The TalkLabs application ID assigned to your account.

Example: your-app-id

userid path

string customer-defined required

The customer defined user ID from your application or identity system.

Example: u-8842

Request

JSON body

Send as application/json.

applyEffect

boolean required

expireSeconds

integer · int32

Request example

{
  "applyEffect": true
}

Request examples

Common variations

Historical examples filtered through the current request schema.

Ban User

{
  "applyEffect": true
}

Restore User

{
  "applyEffect": true
}

Response

Status codes

Every JSON response uses the API result envelope.

200 OK ApiResult

400 Bad Request ApiResult

403 Forbidden ApiResult

500 Internal Server Error ApiResult

curl --request POST \
  --url "https://api.sportstalk247.com/api/v3/${APP_ID}/user/users/${USER_ID}/ban" \
  --header "Accept: application/json" \
  --header "x-api-token: ${TALKLABS_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "applyEffect": true
}'

const appId = process.env.TALKLABS_APP_ID;
const userid = 'u-8842';

const response = await fetch(
  `https://api.sportstalk247.com/api/v3/${appId}/user/users/${userid}/ban`,
{
  method: 'POST',
  headers: {
    Accept: 'application/json',
    'x-api-token': process.env.TALKLABS_API_TOKEN,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "applyEffect": true
}),
});

const result = await response.json();

import json
import os
import requests

app_id = os.environ["TALKLABS_APP_ID"]
userid = "u-8842"

response = requests.post(
    f"https://api.sportstalk247.com/api/v3/{app_id}/user/users/{userid}/ban",
    headers={
        "Accept": "application/json",
        "x-api-token": os.environ["TALKLABS_API_TOKEN"],
    },
    json=json.loads(r'''{
  "applyEffect": true
}'''),
)
response.raise_for_status()
result = response.json()

Environment variables TALKLABS_APP_ID TALKLABS_API_TOKEN

Response