PUT Users & notifications

Notifications: Mark All Read

Unless your workflow must support use of read notifications, notifications should be deleted when read.

PUT /api/v3/{appid}/user/users/{userid}/notification/notifications_all/markread

Unless your workflow must support use of read notifications, notifications should be deleted when read.

This marks all notifications for a user as read with one api call.

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.
delete : (optional, default: true) The read status (true/false) for the notification. If true, all the notifications for the user are deleted. If false, they are marked read.

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

Example: u-8842

delete query

boolean

Optional, default true. If true, all of the user's notifications are deleted. If false, they are marked read not deleted .

Example: true

Response

Status codes

Every JSON response uses the API result envelope.

200 OK: success. ApiResult

400 Bad Request 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

curl --request PUT \
  --url "https://api.sportstalk247.com/api/v3/${APP_ID}/user/users/${USER_ID}/notification/notifications_all/markread?delete=true" \
  --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}/notification/notifications_all/markread?delete=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"

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