Mark Read

Idempotent: an id already read, or belonging to somebody else, is simply not modified.

POST/api/v1/inbox/read

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Request body

requiredapplication/json

idsstring[]required

min items 1 · max items 200

Responses

200Successful Response

successboolean

default: true

dataany

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

422Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X POST "/api/v1/inbox/read" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "ids": [
    "string"
  ]
}'

const response = await fetch("/api/v1/inbox/read", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "ids": [
    "string"
  ]
})
});

import requests

response = requests.post(
    "/api/v1/inbox/read",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    json={
  "ids": [
    "string"
  ]
},
)

Response

{
  "success": true,
  "data": null,
  "message": "string",
  "errors": [
    "string"
  ]
}