Mark notification as read
1 min
POST
https://api.upstartcommerce.com/notifications/v1/notifications/{notificationId}/read
Path Parameters
- notificationIdstring<uuid>requiredDescriptionFormatuuid
Responses
200
- MarkAsReadResponse
- successbooleanrequiredDescription
- messagestringrequiredDescription
401
- ErrorResponse
- errorstring<authentication_failed | insufficient_permissions | invalid_request | not_found>requiredDescriptionAllowedauthentication_failedinsufficient_permissionsinvalid_requestnot_found
- error_descriptionstringrequiredDescription
- required_scopestringDescription
403
- ErrorResponse
- errorstring<authentication_failed | insufficient_permissions | invalid_request | not_found>requiredDescriptionAllowedauthentication_failedinsufficient_permissionsinvalid_requestnot_found
- error_descriptionstringrequiredDescription
- required_scopestringDescription
404
- ErrorResponse
- errorstring<authentication_failed | insufficient_permissions | invalid_request | not_found>requiredDescriptionAllowedauthentication_failedinsufficient_permissionsinvalid_requestnot_found
- error_descriptionstringrequiredDescription
- required_scopestringDescription
curl
curl --request POST \
--url https://api.upstartcommerce.com/notifications/v1/notifications/{notificationId}/read \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'POST',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.upstartcommerce.com/notifications/v1/notifications/{notificationId}/read", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.upstartcommerce.com/notifications/v1/notifications/{notificationId}/read")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.upstartcommerce.com/notifications/v1/notifications/{notificationId}/read"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Notification marked as read
{
"success": false,
"message": ""
}401
// Authentication failed
{
"error": "",
"error_description": "",
"required_scope": ""
}403
// Insufficient permissions
{
"error": "",
"error_description": "",
"required_scope": ""
}404
// Notification not found or access denied
{
"error": "",
"error_description": "",
"required_scope": ""
}