Mark Notifications read
/notifications/readMarks some or all of the user's Notifications read.
Send {ids} with 1 to 100 Notification IDs, or {all: true}. IDs that are unknown, already read or not the user's change nothing and are not counted in markedRead.
Authorization
OAuth 2 bearer token in the Authorization header. Required scope: notifications:read
Request body required
The Notifications to mark read.
Content type:application/json
One of
Option 1
idsarray of string (uuid) requiredmin 1 itemsmax 100 items
all = true
allboolean requiredtrue
Responses
200 How many Notifications were marked read.application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"
dataobjectShow child attributes
markedReadintegermin 0
400 The request is malformed or failed validation. Inspect error.code and error.issues.application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"
dataany | nullAlways null on an error.
errorobjectWhy the request failed.
Show child attributes
codestringStable dotted camelCase code such as
resource.gone. Branch on this, not onmessage.messagestringShort explanation for people. Wording can change.
min length 1max length 256requestIdstringThe Cloudflare ray ID. Absent on Snippet and WAF errors and on cached
404,410and503responses, which carry it only incf-ray.min length 1docsstring (uri)Link to this code's entry in the error catalogue.
detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
issuesarray of objectPer-field validation failures, when any.
max 50 itemsShow item attributes
codestringStable code for this field failure. Branch on this.
min length 1messagestringShort human-readable description of this field failure.
min length 1patharray of stringPath to the failing field, for example
["items", 2, "slot"].detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
401 The access token is missing (auth.required), or invalid, expired or revoked (auth.invalidToken).application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"WWW-AuthenticatestringRFC 6750 challenge:
Bearer realm="mediux", pluserror="invalid_token"for a bad or expired token.
dataany | nullAlways null on an error.
errorobjectWhy the request failed.
Show child attributes
codestringStable dotted camelCase code such as
resource.gone. Branch on this, not onmessage.messagestringShort explanation for people. Wording can change.
min length 1max length 256requestIdstringThe Cloudflare ray ID. Absent on Snippet and WAF errors and on cached
404,410and503responses, which carry it only incf-ray.min length 1docsstring (uri)Link to this code's entry in the error catalogue.
detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
issuesarray of objectPer-field validation failures, when any.
max 50 itemsShow item attributes
codestringStable code for this field failure. Branch on this.
min length 1messagestringShort human-readable description of this field failure.
min length 1patharray of stringPath to the failing field, for example
["items", 2, "slot"].detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
403 The token lacks the required App Permission (auth.insufficientScope, with details.required), or the account or connection may not do this (auth.forbidden).application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"
dataany | nullAlways null on an error.
errorobjectWhy the request failed.
Show child attributes
codestringStable dotted camelCase code such as
resource.gone. Branch on this, not onmessage.messagestringShort explanation for people. Wording can change.
min length 1max length 256requestIdstringThe Cloudflare ray ID. Absent on Snippet and WAF errors and on cached
404,410and503responses, which carry it only incf-ray.min length 1docsstring (uri)Link to this code's entry in the error catalogue.
detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
issuesarray of objectPer-field validation failures, when any.
max 50 itemsShow item attributes
codestringStable code for this field failure. Branch on this.
min length 1messagestringShort human-readable description of this field failure.
min length 1patharray of stringPath to the failing field, for example
["items", 2, "slot"].detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
413 The body exceeds the allowed size.application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"
dataany | nullAlways null on an error.
errorobjectWhy the request failed.
Show child attributes
codestringStable dotted camelCase code such as
resource.gone. Branch on this, not onmessage.messagestringShort explanation for people. Wording can change.
min length 1max length 256requestIdstringThe Cloudflare ray ID. Absent on Snippet and WAF errors and on cached
404,410and503responses, which carry it only incf-ray.min length 1docsstring (uri)Link to this code's entry in the error catalogue.
detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
issuesarray of objectPer-field validation failures, when any.
max 50 itemsShow item attributes
codestringStable code for this field failure. Branch on this.
min length 1messagestringShort human-readable description of this field failure.
min length 1patharray of stringPath to the failing field, for example
["items", 2, "slot"].detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
415 The Content-Type is not application/json.application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"
dataany | nullAlways null on an error.
errorobjectWhy the request failed.
Show child attributes
codestringStable dotted camelCase code such as
resource.gone. Branch on this, not onmessage.messagestringShort explanation for people. Wording can change.
min length 1max length 256requestIdstringThe Cloudflare ray ID. Absent on Snippet and WAF errors and on cached
404,410and503responses, which carry it only incf-ray.min length 1docsstring (uri)Link to this code's entry in the error catalogue.
detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
issuesarray of objectPer-field validation failures, when any.
max 50 itemsShow item attributes
codestringStable code for this field failure. Branch on this.
min length 1messagestringShort human-readable description of this field failure.
min length 1patharray of stringPath to the failing field, for example
["items", 2, "slot"].detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
429 Too many requests. Wait the Retry-After seconds before trying again.application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"Retry-AfterstringSeconds to wait before trying again.
pattern ^\d+$
dataany | nullAlways null on an error.
errorobjectWhy the request failed.
Show child attributes
codestringStable dotted camelCase code such as
resource.gone. Branch on this, not onmessage.messagestringShort explanation for people. Wording can change.
min length 1max length 256requestIdstringThe Cloudflare ray ID. Absent on Snippet and WAF errors and on cached
404,410and503responses, which carry it only incf-ray.min length 1docsstring (uri)Link to this code's entry in the error catalogue.
detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
issuesarray of objectPer-field validation failures, when any.
max 50 itemsShow item attributes
codestringStable code for this field failure. Branch on this.
min length 1messagestringShort human-readable description of this field failure.
min length 1patharray of stringPath to the failing field, for example
["items", 2, "slot"].detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
503 Temporarily unavailable. Check the outcome before retrying a write.application/json
Headers
Cache-ControlstringBrowser caching policy.
"private, no-store"
dataany | nullAlways null on an error.
errorobjectWhy the request failed.
Show child attributes
codestringStable dotted camelCase code such as
resource.gone. Branch on this, not onmessage.messagestringShort explanation for people. Wording can change.
min length 1max length 256requestIdstringThe Cloudflare ray ID. Absent on Snippet and WAF errors and on cached
404,410and503responses, which carry it only incf-ray.min length 1docsstring (uri)Link to this code's entry in the error catalogue.
detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.
issuesarray of objectPer-field validation failures, when any.
max 50 itemsShow item attributes
codestringStable code for this field failure. Branch on this.
min length 1messagestringShort human-readable description of this field failure.
min length 1patharray of stringPath to the failing field, for example
["items", 2, "slot"].detailsmap of string | number | boolean | array of string | nullConstraints that apply to the failure, such as byte limits, dimensions or allowed types.