DELETE Users & notifications

Delete User Notification

Immediately deletes a user notification.

DELETE /api/v3/{appid}/user/users/{userid}/notification/notifications/{notificationid}

Immediately deletes a user notification. Unless your workflow specifically implements access to read notifications, you should delete notifications after they are consumed.

URL Arguments

userid : (required) The ID of the user marking the notification as read. This is used to ensure a user can't mark another user's notification as read.
notificationid : (required) The unique ID of the notification being updated.

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 user the notification belongs to used to ensure a user can't delete another user's notification.

Example: u-8842

notificationid path

string TalkLabs ID required

Required. The unique ID of the notification being deleted.

Response

Status codes

Every JSON response uses the API result envelope.

200 OK: success data is the deleted UserNotification. ApiResult

400 Bad Request ApiResult

403 Forbidden: request is not authorized with a valid token, or the token does not match this appid. ApiResult

404 NotFound: no notification with this ID exists for this user. ApiResult

500 Internal Server Error ApiResult

Example response · 200

{
  "message": "",
  "errors": {},
  "data": {
    "kind": "notification",
    "id": "602456955617e108441660dc",
    "added": "2021-02-10T21:56:37.2243706Z",
    "userid": "bobsmith2",
    "ts": 637485909972243700,
    "whenread": "2021-02-10T21:58:01.9942603Z",
    "isread": true,
    "notificationtype": "chatquote",
    "chatroomid": "600d78d45617e20e34c39dd5",
    "chatroomcustomid": "new-york-city-club",
    "commentconversationid": "",
    "commentconversationcustomid": "",
    "chateventid": "602456955617e108441660db",
    "commentid": ""
  }
}

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

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

const response = await fetch(
  `https://api.sportstalk247.com/api/v3/${appId}/user/users/${userid}/notification/notifications/${notificationid}`,
{
  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"
notificationid = "<notificationid>"

response = requests.delete(
    f"https://api.sportstalk247.com/api/v3/{app_id}/user/users/{userid}/notification/notifications/{notificationid}",
    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