POST Moderate users

Global Purge User

This will delete all chat content from this user and will set all the users comments to LOGICALLY DELETED.

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

This will delete all chat content from this user and will set all the users comments to LOGICALLY DELETED. This means the comments will still be there but the API will return a placeholder instead of the original comment.

URL PARAMETERS

userid: (required) The application provided userid of the user to ban

POST PARAMETERS

byuserid: (optional) The userid of the user issuing the purge command.

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.

byUserId

string customer-defined required

Request example

{
  "byUserId": "<byUserId>"
}

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}/globalpurge" \
  --header "Accept: application/json" \
  --header "x-api-token: ${TALKLABS_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "byUserId": "<byUserId>"
}'

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}/globalpurge`,
{
  method: 'POST',
  headers: {
    Accept: 'application/json',
    'x-api-token': process.env.TALKLABS_API_TOKEN,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "byUserId": "<byUserId>"
}),
});

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}/globalpurge",
    headers={
        "Accept": "application/json",
        "x-api-token": os.environ["TALKLABS_API_TOKEN"],
    },
    json=json.loads(r'''{
  "byUserId": "<byUserId>"
}'''),
)
response.raise_for_status()
result = response.json()

Environment variables TALKLABS_APP_ID TALKLABS_API_TOKEN

Response