PATCH /api/articles/:id/comments/:commentId
Account required · HTTP API reference
All endpoints · Authentication and retries · Download OpenAPI
- Requires a signed-in account and permission to access this resource. Use identifiers returned by your own account's earlier requests.
- Protected writes require an allowed Origin, the CSRF cookie and matching X-CSRF-Token header.
Request
| Parameter | Location | Type and requirement |
|---|---|---|
id | path | string · required |
commentId | path | string · required |
Origin | header | string · required An origin allowed by this deployment. |
X-CSRF-Token | header | string · required Must match the CSRF cookie issued to this browser. |
Body · application/json
text required · stringExample
Examples use fictional data. Replace identifiers with resources you can access. For account requests, cookies.txt must contain your own session; set CSRF_TOKEN to the matching CSRF cookie value where required.
{
"text": "Explain the data used in this research."
}curl --include \
--request PATCH \
'https://api.weavers.app/api/articles/1/comments/1' \
--cookie cookies.txt --cookie-jar cookies.txt \
--header 'Origin: https://weavers.app' \
--header "X-CSRF-Token: ${CSRF_TOKEN}" \
--header 'Content-Type: application/json' \
--data-binary @request.jsonResponses
200 · Successful response.
application/json
{
"id": 1,
"articleId": "1",
"userId": 1,
"displayName": "Example research",
"text": "Explain the data used in this research.",
"createdAt": "2025-01-01T00:00:00.000Z",
"updatedAt": null,
"deletedAt": null,
"parentId": null,
"isOwner": false,
"isDeleted": false
}View response model
id required · numberarticleId required · stringuserId required · numberdisplayName required · stringavatarUrl optional · null | stringView avatarUrl model
Variant 1: null
null
Variant 2: string
string
text required · stringcreatedAt required · stringupdatedAt required · null | stringView updatedAt model
Variant 1: null
null
Variant 2: string
string
deletedAt required · null | stringView deletedAt model
Variant 1: null
null
Variant 2: string
string
parentId required · null | numberView parentId model
Variant 1: null
null
Variant 2: number
number
isOwner required · booleanisDeleted required · booleanAdditional fields: JSON values.
400 · Invalid request.
application/json
{
"error": "example"
}View response model
Variant 1: object
error required · stringAdditional fields: JSON values.
401 · Authentication is missing or invalid.
application/json
{}View response model
Error envelopes can include resource-specific details. Check the status before reading these fields.
error optional · stringcode optional · stringmessage optional · stringAdditional fields: JSON values.
403 · Permission, origin or CSRF check failed.
application/json
{
"error": "example"
}View response model
error required · stringAdditional fields: JSON values.
404 · Resource or enabled capability not found.
application/json
{
"error": "example"
}View response model
Variant 1: object
error required · stringAdditional fields: JSON values.
429 · Rate limit reached; honor Retry-After when supplied.
application/json
{}View response model
Error envelopes can include resource-specific details. Check the status before reading these fields.
error optional · stringcode optional · stringmessage optional · stringAdditional fields: JSON values.
500 · Server failure.
application/json
{
"error": "example"
}View response model
Variant 1: object
error required · stringAdditional fields: JSON values.