curl --request POST \
--url https://{host}/v1/sellers/{sellerId}/buyer-blocks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"type": "buyer-blocks",
"relationships": {
"conversation": {
"data": {
"type": "conversations",
"id": "16916"
}
}
}
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'buyer-blocks',
relationships: {conversation: {data: {type: 'conversations', id: '16916'}}}
}
})
};
fetch('https://{host}/v1/sellers/{sellerId}/buyer-blocks', 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/sellers/{sellerId}/buyer-blocks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'type' => 'buyer-blocks',
'relationships' => [
'conversation' => [
'data' => [
'type' => 'conversations',
'id' => '16916'
]
]
]
]
]),
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/sellers/{sellerId}/buyer-blocks"
payload = { "data": {
"type": "buyer-blocks",
"relationships": { "conversation": { "data": {
"type": "conversations",
"id": "16916"
} } }
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"type": "buyer-blocks",
"id": "12",
"attributes": {
"createdAt": "2026-10-03T07:14:00.000000Z",
"buyerName": "Piet Koper"
},
"links": {
"self": "https://api.wristler.eu/v1/sellers/42/buyer-blocks/12"
}
}
}{
"data": {
"type": "buyer-blocks",
"id": "12",
"attributes": {
"createdAt": "2026-10-03T07:14:00.000000Z",
"buyerName": "Piet Koper"
},
"links": {
"self": "https://api.wristler.eu/v1/sellers/42/buyer-blocks/12"
}
}
}{
"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"
}
}Block buyer
Scope: messages:write
Blocks the buyer of a thread — named by the thread, because that is how a shop knows its buyers. The shop blocks, not the staff member: it holds for every colleague.
Every thread between the shop and that buyer is closed at once, in both directions,
and the buyer cannot open a new one. Messages already sent stay. The buyer still sees
the shop’s watches. Blocking twice is blocking: the second answers 200 with the block
that is already there.
A thread of another shop answers 404. 422 cannot_block_your_own_staff when the
buyer works at this shop.
The block answers with buyerName and createdAt; the thread it was made from is not
in the answer. A thread finds its block with filter[conversation] on the list.
curl --request POST \
--url https://{host}/v1/sellers/{sellerId}/buyer-blocks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"type": "buyer-blocks",
"relationships": {
"conversation": {
"data": {
"type": "conversations",
"id": "16916"
}
}
}
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'buyer-blocks',
relationships: {conversation: {data: {type: 'conversations', id: '16916'}}}
}
})
};
fetch('https://{host}/v1/sellers/{sellerId}/buyer-blocks', 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/sellers/{sellerId}/buyer-blocks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'type' => 'buyer-blocks',
'relationships' => [
'conversation' => [
'data' => [
'type' => 'conversations',
'id' => '16916'
]
]
]
]
]),
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/sellers/{sellerId}/buyer-blocks"
payload = { "data": {
"type": "buyer-blocks",
"relationships": { "conversation": { "data": {
"type": "conversations",
"id": "16916"
} } }
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"type": "buyer-blocks",
"id": "12",
"attributes": {
"createdAt": "2026-10-03T07:14:00.000000Z",
"buyerName": "Piet Koper"
},
"links": {
"self": "https://api.wristler.eu/v1/sellers/42/buyer-blocks/12"
}
}
}{
"data": {
"type": "buyer-blocks",
"id": "12",
"attributes": {
"createdAt": "2026-10-03T07:14:00.000000Z",
"buyerName": "Piet Koper"
},
"links": {
"self": "https://api.wristler.eu/v1/sellers/42/buyer-blocks/12"
}
}
}{
"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