API ReferenceOperator Teams
Create an operator team
Creates a new operator team in the current organization with a name, optional description, routing priority, and project binding scope.
POST
/api/operator-teamsCreates a new operator team in the current organization with a name, optional description, routing priority, and project binding scope. Returns the created team. Conflicts return a 409 response.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
operator-teams: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.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body accepted by this operation.
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
{ "team": { "id": "5482ca34-d0cf-46a4-96ef-748803087ae1", "orgId": "8ea0b557-d794-41ce-b86e-44f4780da2b5", "projectScope": "all", "projectIds": [ "11111111-1111-4111-8111-111111111111" ], "name": "Billing", "description": "Handles billing conversations.", "priority": 20, "createdAt": "2026-08-03T18:00:00.000Z", "updatedAt": "2026-08-03T18:00:00.000Z" }}Request examples
curl
curl --request POST \
'https://api.convor.io/api/operator-teams' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"projectScope": "all",
"projectIds": [],
"name": "Billing",
"description": "Handles billing conversations.",
"priority": 20
}'JavaScript
const response = await fetch("https://api.convor.io/api/operator-teams", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"projectScope": "all",
"projectIds": [],
"name": "Billing",
"description": "Handles billing conversations.",
"priority": 20
}),
});
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?