DELETE Chat

Delete Room

This cannot be reversed.

DELETE /api/v3/{appid}/chat/rooms/{roomid}

This cannot be reversed. This command permanently deletes the chat room and all events in it.

URL Parameters

roomid : (required) The room to be deleted.

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

roomid path

string TalkLabs ID required

The TalkLabs assigned room ID returned when the room was created.

Example: room-id

Response

Status codes

Every JSON response uses the API result envelope.

200 OK ApiResult

400 Bad Request ApiResult

403 Forbidden ApiResult

404 Not Found ApiResult

500 Internal Server Error ApiResult

Example response · 200

{
  "message": "Room deleted successfully.",
  "errors": {},
  "data": {
    "kind": "deleted.room",
    "deletedEventsCount": 0,
    "room": {
      "kind": "chat.room",
      "id": "5fe33c045617e2126867c5f6",
      "appid": "5edbd0fb5617e609c00ff168",
      "ownerid": null,
      "name": "Test Room to be Deleted (Post-Moderated)",
      "description": "We have but one life to live",
      "pictureurl": "",
      "customtype": "",
      "customid": "Test_Room_Delete_Me",
      "custompayload": "",
      "customtags": [],
      "customfield1": "",
      "customfield2": "",
      "enableactions": true,
      "enableenterandexit": true,
      "open": true,
      "inroom": 0,
      "added": "2020-12-23T12:45:56.4938555Z",
      "whenmodified": "2020-12-23T12:45:56.4938555Z",
      "moderation": "post",
      "maxreports": 0,
      "enableprofanityfilter": true,
      "delaymessageseconds": 0,
      "bouncedusers": [],
      "shadowbannedusers": []
    }
  }
}

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

const appId = process.env.TALKLABS_APP_ID;
const roomid = 'room-id';

const response = await fetch(
  `https://api.sportstalk247.com/api/v3/${appId}/chat/rooms/${roomid}`,
{
  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"]
roomid = "room-id"

response = requests.delete(
    f"https://api.sportstalk247.com/api/v3/{app_id}/chat/rooms/{roomid}",
    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