Update a conversation
Updates mutable conversation fields such as status, priority, assigned operator, and metadata.
/api/conversations/{id}Updates mutable conversation fields such as status, priority, assigned operator, and metadata. Operator access is required. If expectedVersion is provided, the request uses optimistic locking and returns a conflict when the stored version has changed since the client last read it.
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)$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
Mutable conversation fields.
TypeScript Definitions
Use the request body type in TypeScript.
Mutable conversation fields.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "id": "11111111-1111-4111-8111-111111111111", "organizationId": "22222222-2222-4222-8222-222222222222", "projectId": "11111111-1111-4111-8111-111111111111", "projectName": "Example name", "visitorId": "33333333-3333-4333-8333-333333333333", "operatorId": null, "status": "closed", "priority": "high", "source": "api", "aiEnabled": true, "locale": "en", "localeSource": "organization_default", "localeLocked": false, "localeUpdatedAt": null, "lastMessageAt": "2026-06-23T09:08:00.000Z", "title": "Billing question", "messageCount": 14, "hasUnreadMessages": false, "tags": [], "customFields": {}, "languageConfidence": 1, "languageSource": "manual", "translationActive": true, "translationTargetLanguage": "example", "metadata": {}, "version": 4, "createdAt": "2026-06-23T08:55:00.000Z", "updatedAt": "2026-06-23T09:10:00.000Z", "closedAt": "2026-06-23T09:10:00.000Z", "visitor": null, "lastMessage": null, "unreadCount": 0}Request examples
curl
curl --request PATCH \
'https://api.convor.io/api/conversations/11111111-1111-4111-8111-111111111111' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"status": "closed",
"priority": "high",
"expectedVersion": 3
}'JavaScript
const response = await fetch("https://api.convor.io/api/conversations/11111111-1111-4111-8111-111111111111", {
method: "PATCH",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"status": "closed",
"priority": "high",
"expectedVersion": 3
}),
});
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?