DELETE Users & notifications

Delete User

All rooms with messages by that user will have the messages from this user purged in the rooms.

DELETE /api/v3/{appid}/user/users/{userid}

All rooms with messages by that user will have the messages from this user purged in the rooms.

This method requires authentication.

UserId is the app specific User ID provided by your application.

Request

Parameters

Values in the path and query string.

appid path

string TalkLabs ID required

The application the user belongs to.

Example: your-app-id

userid path

string customer-defined required

Required. The app specific user ID to delete.

Example: u-8842

Response

Status codes

Every JSON response uses the API result envelope.

200 OK: success data is a ResponseDeleteAppUser kind "deleted.appuser" containing the deleted user's last known record. ApiResult

400 BadRequest: the userid parameter was not provided. ApiResult

403 Forbidden: request is not authorized with a valid token. ApiResult

404 NotFound: no user exists for the given userid. ApiResult

500 Internal Server Error ApiResult

curl --request DELETE \
  --url "https://api.sportstalk247.com/api/v3/${APP_ID}/user/users/${USER_ID}" \
  --header "Accept: application/json" \
  --header "x-api-token: ${TALKLABS_API_TOKEN}"

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}`,
{
  method: 'DELETE',
  headers: {
    Accept: 'application/json',
    'x-api-token': process.env.TALKLABS_API_TOKEN,
  },
});

const result = await response.json();

import json
import os
import requests

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

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

Environment variables TALKLABS_APP_ID TALKLABS_API_TOKEN

Response