API ReferenceOperators
Update operator settings
Partially updates an operator's assignment settings in the authenticated organization.
PATCH
/api/operators/{id}Partially updates an operator's assignment settings in the authenticated organization. Admin access is required. Omitted fields remain unchanged; a null maxConcurrentChats value means unlimited concurrent conversations. Status can be saved atomically with the rest of the operator profile.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
operators: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
id*string
Resource identifier.
Match
^([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)$Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body accepted by this operation.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "id": "550e8400-e29b-41d4-a716-446655440000", "userId": "22222222-2222-4222-8222-222222222222", "orgId": "11111111-1111-4111-8111-111111111111", "displayName": "Alice Johnson", "status": "online", "lastSeenAt": "2026-06-23T09:00:00.000Z", "maxConcurrentChats": 8, "acceptingNewConversations": true, "isAcceptingNewConversations": true, "skills": [ "billing", "vip" ], "availabilitySchedule": { "days": { "monday": { "allDay": false, "ranges": [ { "start": "09:00", "end": "17:00" } ] }, "tuesday": { "allDay": false, "ranges": [ { "start": "09:00", "end": "17:00" } ] }, "wednesday": { "allDay": false, "ranges": [ { "start": "09:00", "end": "17:00" } ] }, "thursday": { "allDay": false, "ranges": [ { "start": "09:00", "end": "17:00" } ] }, "friday": { "allDay": false, "ranges": [ { "start": "09:00", "end": "17:00" } ] }, "saturday": { "allDay": false, "ranges": [] }, "sunday": { "allDay": false, "ranges": [] } } }, "timezone": "Europe/Warsaw", "dashboardLayout": [], "createdAt": "2026-06-01T09:00:00.000Z", "updatedAt": "2026-06-23T09:00:00.000Z"}Request examples
curl
curl --request PATCH \
'https://api.convor.io/api/operators/550e8400-e29b-41d4-a716-446655440000' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"maxConcurrentChats": 8,
"acceptingNewConversations": true,
"status": "online"
}'JavaScript
const response = await fetch("https://api.convor.io/api/operators/550e8400-e29b-41d4-a716-446655440000", {
method: "PATCH",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"maxConcurrentChats": 8,
"acceptingNewConversations": true,
"status": "online"
}),
});
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?