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. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `conversations:write` scope. API-key access also requires the Automation & API module (`automation_api`). Authorized dashboard sessions remain supported where the route already permits them. The request is isolated to the authenticated organization. Resource and site/project identifiers must belong to that organization; out-of-scope identifiers are not disclosed. When a version is supplied, stale updates fail with a conflict instead of overwriting a newer change. Successful mutations invalidate cached lists and publish the route's documented realtime and webhook events. Retry behavior: Repeating the same request converges on the same resource state, but a retry may return a conflict or not-found response after the first request succeeds.
/api/conversations/{id}Organization API key supplied as Authorization: Bearer convor_sk_....
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{
"id": "conv_123",
"orgId": "org_123",
"visitorId": "visitor_123",
"status": "closed",
"priority": "high",
"subject": null,
"assignedOperatorId": null,
"metadata": {},
"createdAt": "2026-06-23T08:55:00.000Z",
"updatedAt": "2026-06-23T09:10:00.000Z",
"lastMessageAt": "2026-06-23T09:08:00.000Z",
"closedAt": "2026-06-23T09:10:00.000Z",
"version": 4,
"visitor": null,
"lastMessage": null,
"unreadCount": 0,
"tags": [],
"messageCount": 14
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}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
}'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?
Unsnooze a conversation
Clears the `snoozedUntil` timestamp for one conversation in the current organization and makes the conversation active again. This endpoint does not take a request body. On success it returns the updated conversation, writes an audit log entry, and emits the standard unsnooze webhook and realtime events. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `conversations:write` scope. API-key access also requires the Automation & API module (`automation_api`). Authorized dashboard sessions remain supported where the route already permits them. The request is isolated to the authenticated organization. Resource and site/project identifiers must belong to that organization; out-of-scope identifiers are not disclosed. Retry behavior: Repeating the same request converges on the same resource state, but a retry may return a conflict or not-found response after the first request succeeds.
Conversation Tags
Tagging and labeling conversations