PUT Users & notifications

Set Notification Read Status

Unless your workflow must support use of read notifications, use DELETE USER NOTIFICATION instead.

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

Unless your workflow must support use of read notifications, use DELETE USER NOTIFICATION instead.

This marks a notification as being in READ status. That will prevent the notification from being returned in a call to List User Notifications unless the default filters are overridden. Notifications that are marked as read will be automatically deleted after some time.

Calling this over and over again for an event, or calling it on events where the reader is not the person that the reply is directed to, or calling it against events that are not type ChatReply or ChatQuote is inappropriate use of the API.

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.
read : (required) The read status (true/false) for the notification. You can pass false to mark the notification as unread.

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

Example: u-8842

notificationid path

string TalkLabs ID required

Required. The unique ID of the notification being updated.

read query

boolean

Required. The read status true/false to set. Pass false to mark the notification unread again.

Example: true

Response

Status codes

Every JSON response uses the API result envelope.

200 OK: success data is the updated UserNotification. ApiResult

400 BadRequest: the required read parameter was not provided. ApiResult

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

500 Internal Server Error ApiResult

Example response · 200

{
  "message": "",
  "errors": {},
  "data": {
    "kind": "notification",
    "id": "602456795617e108441660da",
    "added": "2021-02-10T21:56:09.9738413Z",
    "userid": "bobsmith2",
    "ts": 637485909699738400,
    "whenread": "2021-02-10T21:56:26.9429317Z",
    "isread": true,
    "notificationtype": "chatquote",
    "chatroomid": "600d78d45617e20e34c39dd5",
    "chatroomcustomid": "new-york-city-club",
    "commentconversationid": "",
    "commentconversationcustomid": "",
    "chateventid": "602456795617e108441660d9",
    "commentid": ""
  }
}

curl --request PUT \
  --url "https://api.sportstalk247.com/api/v3/${APP_ID}/user/users/${USER_ID}/notification/notifications/${NOTIFICATION_ID}/update?read=true" \
  --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}/update?read=true`,
{
  method: 'PUT',
  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.put(
    f"https://api.sportstalk247.com/api/v3/{app_id}/user/users/{userid}/notification/notifications/{notificationid}/update?read=true",
    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