Edit a message
Updates the content of one non-deleted message and returns the full message.
/api/conversations/{id}/messages/{messageId}Updates the content of one non-deleted message and returns the full message. Edits are allowed only during the 5-minute grace period after message creation. Visitor callers can access only their own conversations and can edit only visitor messages they authored. The endpoint sanitizes the content, preserves up to 20 prior versions in edit history, refreshes search indexing, publishes a message_edited realtime event, and fires a message.updated webhook.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
conversations:write- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Convergent write: Retrying leaves the resource in the same resulting state. If the first request succeeded, a later retry may return conflict or not found because the change has already taken effect.
Path Parameters
Resource identifier.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidResource identifier.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$uuidHeader Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Request Body
application/json
Editable message fields.
TypeScript Definitions
Use the request body type in TypeScript.
Editable message fields.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "id": "7f1f4d83-0a0e-4f34-9c4b-9a98d6e1c2ab", "orgId": "8a8f4d83-0a0e-4f34-9c4b-9a98d6e1c2ab", "conversationId": "9f1f4d83-0a0e-4f34-9c4b-9a98d6e1c2ab", "senderType": "visitor", "senderId": "550e8400-e29b-41d4-a716-446655440000", "content": "Updated message text", "type": "text", "metadata": {}, "isRead": false, "isEdited": true, "editedAt": "2026-06-23T08:05:00.000Z", "createdAt": "2026-06-23T08:00:00.000Z", "deletedAt": null, "replyToId": null, "mentions": null, "searchVector": "'updated':1 'message':2 'text':3"}Request examples
curl
curl --request PATCH \
'https://api.convor.io/api/conversations/11111111-1111-4111-8111-111111111111/messages/33333333-3333-4333-8333-333333333333' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"content": "Updated message text"
}'JavaScript
const response = await fetch("https://api.convor.io/api/conversations/11111111-1111-4111-8111-111111111111/messages/33333333-3333-4333-8333-333333333333", {
method: "PATCH",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"content": "Updated message text"
}),
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?