Edit a Comment
Edits the text of a comment the signed-in person wrote.
Updated
PATCH
/v1/comments/{comment}curl -X PATCH "https://api.orshot.com/v1/comments/<COMMENT>" \
-H "Authorization: Bearer <ORSHOT_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
"body": "<BODY>"
}'const res = await fetch("https://api.orshot.com/v1/comments/<COMMENT>", {
method: "PATCH",
headers: {
"Content-Type": "application/json",
Authorization: "Bearer <ORSHOT_API_KEY>",
},
body: JSON.stringify({
"body": "<BODY>"
}),
});
const data = await res.json();import requests
response = requests.patch(
"https://api.orshot.com/v1/comments/<COMMENT>",
headers={"Authorization": "Bearer <ORSHOT_API_KEY>"},
json={
"body": "<BODY>"
},
)
data = response.json()$ch = curl_init("https://api.orshot.com/v1/comments/<COMMENT>");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer <ORSHOT_API_KEY>",
"Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
"body" => "<BODY>"
]));
$data = json_decode(curl_exec($ch), true);
curl_close($ch);require "net/http"
require "json"
uri = URI("https://api.orshot.com/v1/comments/<COMMENT>")
req = Net::HTTP::Patch.new(uri)
req["Authorization"] = "Bearer <ORSHOT_API_KEY>"
req["Content-Type"] = "application/json"
req.body = {
"body": "<BODY>"
}.to_json
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)Enterprise Only
The Approvals API is available on Enterprise plans, or through first-party apps (the Orshot app and the Orshot MCP server). This endpoint needs move access.
See Enterprise pricing to get access.
Edits the text of a comment the signed-in person wrote. Mentions follow the same rules as comment: up to 20 workspace members, names taken from their profiles when saved. Other people's comments cannot be edited, only hidden by owners and admins.
Endpoint#
https://api.orshot.com/v1/comments/:commentPath Parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
comment | Integer | Yes | The comment's id. |
Request Body#
| Parameter | Type | Required | Description |
|---|---|---|---|
body | String | Yes | Comment text. @mention up to 20 people as @[Name](user:<uuid>). Each name is replaced with the person's profile name when saved. Up to 5000 characters. |
Headers#
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <API key or OAuth token> |
x-workspace-id | No | OAuth tokens with several workspaces: the workspace to act in. API keys ignore it. |
X-Orshot-User-Id | No | API keys only: the user id of the owner, admin or member this call is for. See Acting for a Team Member below. |
X-Session-Id | No | Groups the calls of one agent or MCP session in the activity history. |
Acting for a Team Member#
With an API key, you can send X-Orshot-User-Id with the user id of an owner, admin or member of the workspace to make this call for them. It needs both the key's access level and that person's own access, and it's credited to them: people see "Priya Shah, via API key", and they aren't notified about their own change. See acting for a team member.
Request#
await fetch("https://api.orshot.com/v1/comments/4", {
method: "PATCH",
headers: {
"Content-Type": "application/json",
Authorization: "Bearer <ORSHOT_API_KEY>",
},
body: JSON.stringify({
"body": "@[Priya Shah](user:9a4c7e2b-1d6f-4e3a-8b5c-2f7d0e9a4c61) can you check the \"50% off\" claim in the headline?"
}),
});{
"comment": {
"id": 4,
"templateId": 101,
"parentId": null,
"author": {
"id": "b5d2e8f1-7a3c-4b69-9e0d-3c8a1f6b2e45",
"name": "Jordan Lee",
"email": "jordan@acme.com",
"role": "member"
},
"body": "@[Priya Shah](user:9a4c7e2b-1d6f-4e3a-8b5c-2f7d0e9a4c61) can you check the \"50% off\" claim in the headline?",
"anchor": null,
"item": null,
"resolvedAt": null,
"editedAt": "2026-09-28T09:30:00.000Z",
"deletedAt": null,
"createdAt": "2026-09-28T09:30:00.000Z"
},
"warnings": []
}Response Fields#
Responds 200 with:
| Field | Type | Description |
|---|---|---|
comment | Object | One Comment, fields below. |
comment.id | Integer | Numeric id. |
comment.templateId | Integer | The template's id. |
comment.parentId | Integer | Can be null. |
comment.author | Object | One Person. The team member it was posted for when an API key sent X-Orshot-User-Id, else the person or { type: api_key, id, label }. |
comment.postedVia | Object | { type: api_key, id, label }. Only on a comment an API key posted for a team member (X-Orshot-User-Id): the key it came through, so it reads "Priya Shah, via API key". |
comment.body | String | |
comment.anchor | Object | { page, elementId, x, y }. Can be null. |
comment.item | Object | { id, flowId, stageId }. Context when written. Can be null. |
comment.resolvedAt | String | ISO 8601 timestamp. Can be null. |
comment.editedAt | String | ISO 8601 timestamp. Can be null. |
comment.createdAt | String | ISO 8601 timestamp. |
warnings | Array | Non-blocking notices, each { code, message? }, for example no_approver. Always present on writes, empty when there is nothing to say. |
Error Responses#
Every error has the same body: error, code, message and helpUrl, plus the fields that apply (required, role, context, blockers, violations, issues, current). Branch on error; code is more specific. See the error reference.
| Status Code | Error | Description |
|---|---|---|
| 401 | oauth_token_invalid | The OAuth token is invalid, expired or revoked. |
| 403 | api_key_missing | No Authorization: Bearer header. |
| 403 | permission_denied | You don't have access to do this. Ask an owner or admin. code names the capability, for example approval.item.decide_denied; required and role say what was missing. With code: insufficient_scope: the OAuth token lacks workspace:approvals:write. With code: approval.member_header_not_member: X-Orshot-User-Id names someone who isn't an owner, admin or member of the workspace now. With code: approval.member_header_not_allowed: an OAuth token sent X-Orshot-User-Id. |
| 403 | plan_required | The workspace's plan doesn't include Approvals, or doesn't include this part of it. |
| 403 | enterprise_api_required | Using approvals with an API key needs an Enterprise plan. Contact hi@orshot.com to turn it on. |
| 404 | not_found | This doesn't exist or isn't available to you. Reviewers get this, never 403, for flows and templates outside their access. |
| 422 | validation_failed | Some fields aren't valid: the fields listed in issues. issues lists each field with a path and a reason. |
| 422 | validation_failed | With code: approval.member_header_invalid: X-Orshot-User-Id isn't a user id. |
| 429 | rate_limit_exceeded | More than 120 approvals requests in a minute from one person or key. Wait for Retry-After. |
| 503 | approvals_unavailable | Approvals aren't available right now. Try again in a moment. Also returned while approvals are not switched on for the API. |
Was this page helpful?
Ready to automate?
Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.
Get your API key- Image, PDF and video generation via API
- Visual editor with AI and smart layouts
- Zapier, Make, MCP and 50+ integrations
- White-label embed for your own app
- 100 free credits a month, no credit card required