curl --request PATCH \
--url https://{host}/v1/conversations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"type": "conversations",
"id": "3390",
"attributes": {
"archived": true
}
}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({data: {type: 'conversations', id: '3390', attributes: {archived: true}}})
};
fetch('https://{host}/v1/conversations/{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/conversations/{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' => 'conversations',
'id' => '3390',
'attributes' => [
'archived' => true
]
]
]),
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/conversations/{id}"
payload = { "data": {
"type": "conversations",
"id": "3390",
"attributes": { "archived": True }
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/vnd.api+json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"type": "conversations",
"id": "3312",
"attributes": {
"side": "seller",
"unread": true,
"archived": false,
"noReplyNeeded": false,
"buyer": {
"name": "Jens Urlbauer",
"initials": "JU",
"estimatedCountry": "DE"
},
"blocked": false,
"blockedByYou": false,
"purpose": "propose_price",
"lastMessage": {
"id": "88120",
"excerpt": "Price proposal",
"from": "seller",
"mine": false,
"createdAt": "2026-09-21T09:30:11+02:00",
"removed": false,
"priceProposal": {
"amount": 1300000,
"currency": "EUR",
"from": "seller",
"status": "pending",
"open": true,
"payable": true,
"generatedBody": true
}
},
"agreedPrice": 1300000,
"order": null,
"createdAt": "2026-09-20T10:00:00.000000Z",
"updatedAt": "2026-09-21T07:30:11.000000Z"
},
"relationships": {
"watch": {
"links": {
"related": "https://api.wristler.eu/v1/conversations/3312/watch"
}
},
"seller": {
"links": {
"related": "https://api.wristler.eu/v1/conversations/3312/seller"
}
},
"messages": {
"links": {
"related": "https://api.wristler.eu/v1/conversations/3312/messages"
}
}
},
"links": {
"self": "https://api.wristler.eu/v1/conversations/3312"
}
}
}{
"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"
}
}{
"errors": [
{
"status": "404",
"code": "watch_reserved",
"title": "Not Found",
"detail": "<string>",
"meta": {},
"source": {
"pointer": "/data/attributes/reference",
"parameter": "<string>"
}
}
],
"jsonapi": {
"version": "1.0"
}
}Update thread status
Scope: messages:write
Three fields, all from your own end of the thread, and nothing else — the rest is a record of what two people said, or state we keep ourselves.
unread: false | Mark it read. This is the only thing that does; fetching the thread does not. |
unread: true | Put it back on the pile. |
archived: true / false | File it away, or take it back out. |
noReplyNeeded: true / false | The shop’s side only. Nothing here needs an answer: the “buyers are waiting” reminder (shop_unanswered) stops for this thread until the buyer writes again, at which point it reads false by itself. The buyer’s side reads null and sending it answers 422 only_the_shop. |
Send only what you are changing: a PATCH carrying archived alone leaves the
read mark exactly as it was. Which of the two columns unread or archived means
follows from who is asking, so a client never has to know there are two.
Neither counts as activity, so neither moves the thread to the top of the list. A reply does.
curl --request PATCH \
--url https://{host}/v1/conversations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"type": "conversations",
"id": "3390",
"attributes": {
"archived": true
}
}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({data: {type: 'conversations', id: '3390', attributes: {archived: true}}})
};
fetch('https://{host}/v1/conversations/{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/conversations/{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' => 'conversations',
'id' => '3390',
'attributes' => [
'archived' => true
]
]
]),
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/conversations/{id}"
payload = { "data": {
"type": "conversations",
"id": "3390",
"attributes": { "archived": True }
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/vnd.api+json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"data": {
"type": "conversations",
"id": "3312",
"attributes": {
"side": "seller",
"unread": true,
"archived": false,
"noReplyNeeded": false,
"buyer": {
"name": "Jens Urlbauer",
"initials": "JU",
"estimatedCountry": "DE"
},
"blocked": false,
"blockedByYou": false,
"purpose": "propose_price",
"lastMessage": {
"id": "88120",
"excerpt": "Price proposal",
"from": "seller",
"mine": false,
"createdAt": "2026-09-21T09:30:11+02:00",
"removed": false,
"priceProposal": {
"amount": 1300000,
"currency": "EUR",
"from": "seller",
"status": "pending",
"open": true,
"payable": true,
"generatedBody": true
}
},
"agreedPrice": 1300000,
"order": null,
"createdAt": "2026-09-20T10:00:00.000000Z",
"updatedAt": "2026-09-21T07:30:11.000000Z"
},
"relationships": {
"watch": {
"links": {
"related": "https://api.wristler.eu/v1/conversations/3312/watch"
}
},
"seller": {
"links": {
"related": "https://api.wristler.eu/v1/conversations/3312/seller"
}
},
"messages": {
"links": {
"related": "https://api.wristler.eu/v1/conversations/3312/messages"
}
}
},
"links": {
"self": "https://api.wristler.eu/v1/conversations/3312"
}
}
}{
"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"
}
}{
"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