curl --request PATCH \
--url https://{host}/v1/me/notifications/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"type": "notifications",
"id": "9f1c2b7e-4a3d-4f11-8c2a-1b6d5e0f7a92",
"attributes": {
"unread": false
}
}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'notifications',
id: '9f1c2b7e-4a3d-4f11-8c2a-1b6d5e0f7a92',
attributes: {unread: false}
}
})
};
fetch('https://{host}/v1/me/notifications/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/v1/me/notifications/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'type' => 'notifications',
'id' => '9f1c2b7e-4a3d-4f11-8c2a-1b6d5e0f7a92',
'attributes' => [
'unread' => false
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/vnd.api+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://{host}/v1/me/notifications/{id}"
payload = { "data": {
"type": "notifications",
"id": "9f1c2b7e-4a3d-4f11-8c2a-1b6d5e0f7a92",
"attributes": { "unread": False }
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/vnd.api+json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"type": "notifications",
"id": "9f1c2b7e-4a3d-4f11-8c2a-1b6d5e0f7a92",
"attributes": {
"category": "offers",
"event": "proposal_received",
"title": "€ 12.000 for Submariner Date",
"body": "Amsterdam Watch Co sent you a price. It stands for 48 hours.",
"route": {
"type": "offers",
"event": "proposal_received",
"notificationId": "9f1c2b7e-4a3d-4f11-8c2a-1b6d5e0f7a92",
"conversationId": "16916",
"messageId": "71405",
"watchId": "223897"
},
"unread": false,
"createdAt": "2026-09-26T05:41:12.000000Z",
"readAt": "2026-09-26T05:44:02.000000Z"
},
"links": {
"self": "https://api.wristler.eu/v1/me/notifications/9f1c2b7e-4a3d-4f11-8c2a-1b6d5e0f7a92"
}
}
}{
"errors": [
{
"status": "404",
"code": "watch_reserved",
"title": "Not Found",
"detail": "<string>",
"meta": {},
"source": {
"pointer": "/data/attributes/reference",
"parameter": "<string>"
}
}
],
"jsonapi": {
"version": "1.0"
}
}{
"errors": [
{
"status": "404",
"code": "watch_reserved",
"title": "Not Found",
"detail": "<string>",
"meta": {},
"source": {
"pointer": "/data/attributes/reference",
"parameter": "<string>"
}
}
],
"jsonapi": {
"version": "1.0"
}
}Mark notification read
Scope: account:write
{"unread": false} and nothing else. Reading the list does not mark anything: a client
says when it has shown somebody a notification, which is not the same moment as
fetching it — the same reasoning as a conversation’s unread.
true puts it back on the pile, which is a thing people do on purpose.
curl --request PATCH \
--url https://{host}/v1/me/notifications/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"type": "notifications",
"id": "9f1c2b7e-4a3d-4f11-8c2a-1b6d5e0f7a92",
"attributes": {
"unread": false
}
}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'notifications',
id: '9f1c2b7e-4a3d-4f11-8c2a-1b6d5e0f7a92',
attributes: {unread: false}
}
})
};
fetch('https://{host}/v1/me/notifications/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{host}/v1/me/notifications/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'type' => 'notifications',
'id' => '9f1c2b7e-4a3d-4f11-8c2a-1b6d5e0f7a92',
'attributes' => [
'unread' => false
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/vnd.api+json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://{host}/v1/me/notifications/{id}"
payload = { "data": {
"type": "notifications",
"id": "9f1c2b7e-4a3d-4f11-8c2a-1b6d5e0f7a92",
"attributes": { "unread": False }
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/vnd.api+json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"type": "notifications",
"id": "9f1c2b7e-4a3d-4f11-8c2a-1b6d5e0f7a92",
"attributes": {
"category": "offers",
"event": "proposal_received",
"title": "€ 12.000 for Submariner Date",
"body": "Amsterdam Watch Co sent you a price. It stands for 48 hours.",
"route": {
"type": "offers",
"event": "proposal_received",
"notificationId": "9f1c2b7e-4a3d-4f11-8c2a-1b6d5e0f7a92",
"conversationId": "16916",
"messageId": "71405",
"watchId": "223897"
},
"unread": false,
"createdAt": "2026-09-26T05:41:12.000000Z",
"readAt": "2026-09-26T05:44:02.000000Z"
},
"links": {
"self": "https://api.wristler.eu/v1/me/notifications/9f1c2b7e-4a3d-4f11-8c2a-1b6d5e0f7a92"
}
}
}{
"errors": [
{
"status": "404",
"code": "watch_reserved",
"title": "Not Found",
"detail": "<string>",
"meta": {},
"source": {
"pointer": "/data/attributes/reference",
"parameter": "<string>"
}
}
],
"jsonapi": {
"version": "1.0"
}
}{
"errors": [
{
"status": "404",
"code": "watch_reserved",
"title": "Not Found",
"detail": "<string>",
"meta": {},
"source": {
"pointer": "/data/attributes/reference",
"parameter": "<string>"
}
}
],
"jsonapi": {
"version": "1.0"
}
}Authorizations
Headers
Optional. A UUID per logical operation, not per attempt: a retry carrying the same key gets the first attempt's answer back, headers and all, rather than performing the write twice. Honoured for 24 hours.
A refusal is an answer. A 422 is remembered like any other, so sending a
corrected body under the same key answers 422 idempotency_key_reuse rather
than accepting the correction — the point of a key is that one key means one
decision. Use a new key for a new attempt at the request, and keep the old one
only for retrying the same bytes after a timeout.
A 5xx is the exception: nothing was decided, so the key is released and the
same one may be retried.
| Refusal | Status | code |
|---|---|---|
| The same key with a different body | 422 | idempotency_key_reuse |
| The first request with this key is still running | 409 | idempotency_in_progress |
| The key's record vanished between two requests: retry with a new key | 409 | idempotency_conflict |
| A key longer than 191 characters | 400 | idempotency_key_invalid |
A replayed answer carries Idempotent-Replay: true.
191