curl --request POST \
--url https://{host}/v1/conversations/{conversationId}/reports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"type": "reports",
"attributes": {
"reason": "off_platform_payment",
"note": "They asked me to pay by bank transfer."
},
"relationships": {
"message": {
"data": {
"type": "messages",
"id": "71398"
}
}
}
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'reports',
attributes: {reason: 'off_platform_payment', note: 'They asked me to pay by bank transfer.'},
relationships: {message: {data: {type: 'messages', id: '71398'}}}
}
})
};
fetch('https://{host}/v1/conversations/{conversationId}/reports', 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/{conversationId}/reports",
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' => 'reports',
'attributes' => [
'reason' => 'off_platform_payment',
'note' => 'They asked me to pay by bank transfer.'
],
'relationships' => [
'message' => [
'data' => [
'type' => 'messages',
'id' => '71398'
]
]
]
]
]),
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/{conversationId}/reports"
payload = { "data": {
"type": "reports",
"attributes": {
"reason": "off_platform_payment",
"note": "They asked me to pay by bank transfer."
},
"relationships": { "message": { "data": {
"type": "messages",
"id": "71398"
} } }
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"type": "reports",
"id": "18",
"attributes": {
"reason": "off_platform_payment",
"note": "They asked me to pay by bank transfer.",
"createdAt": "2026-09-26T09:04:00.000000Z"
},
"links": {
"self": "https://api.wristler.eu/v1/conversations/3312/reports/18"
}
}
}{
"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"
}
}{
"errors": [
{
"status": "404",
"code": "watch_reserved",
"title": "Not Found",
"detail": "<string>",
"meta": {},
"source": {
"pointer": "/data/attributes/reference",
"parameter": "<string>"
}
}
],
"jsonapi": {
"version": "1.0"
}
}Report conversation
Scope: messages:write
Either side may report: a shop being sworn at is the same problem as a buyer being pressured.
reason is one of GET /v1/report-reasons. A message relationship points at
one message, which is optional — “this conversation is a problem” is a real
report, and making somebody pick a line loses the ones that are about a pattern.
The message has to belong to this thread, or 422 message_not_in_conversation.
note is their own words, 3 to 2000 characters, and is required when the reason
needs one (needsNote).
What is said is copied into the report as it stands, because a message can be removed by a moderator and a thread can go with a deleted account — a report whose subject has vanished cannot be acted on.
Reporting the same thread twice is allowed: the second report usually carries
what the first was missing. What is not allowed is a hundred of them, so a
caller past ten in an hour hears 429 too_many_reports with Retry-After.
Reporting is not blocking, and neither implies the other. Blocking is
POST /v1/me/blocks for a buyer and POST /v1/sellers/{sellerId}/buyer-blocks for a
shop.
curl --request POST \
--url https://{host}/v1/conversations/{conversationId}/reports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"data": {
"type": "reports",
"attributes": {
"reason": "off_platform_payment",
"note": "They asked me to pay by bank transfer."
},
"relationships": {
"message": {
"data": {
"type": "messages",
"id": "71398"
}
}
}
}
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: 'reports',
attributes: {reason: 'off_platform_payment', note: 'They asked me to pay by bank transfer.'},
relationships: {message: {data: {type: 'messages', id: '71398'}}}
}
})
};
fetch('https://{host}/v1/conversations/{conversationId}/reports', 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/{conversationId}/reports",
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' => 'reports',
'attributes' => [
'reason' => 'off_platform_payment',
'note' => 'They asked me to pay by bank transfer.'
],
'relationships' => [
'message' => [
'data' => [
'type' => 'messages',
'id' => '71398'
]
]
]
]
]),
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/{conversationId}/reports"
payload = { "data": {
"type": "reports",
"attributes": {
"reason": "off_platform_payment",
"note": "They asked me to pay by bank transfer."
},
"relationships": { "message": { "data": {
"type": "messages",
"id": "71398"
} } }
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"type": "reports",
"id": "18",
"attributes": {
"reason": "off_platform_payment",
"note": "They asked me to pay by bank transfer.",
"createdAt": "2026-09-26T09:04:00.000000Z"
},
"links": {
"self": "https://api.wristler.eu/v1/conversations/3312/reports/18"
}
}
}{
"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"
}
}{
"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