Invite an operator to the organization
Invites a user to the authenticated organization as an operator, admin, or viewer.
/api/operators/inviteInvites a user to the authenticated organization as an operator, admin, or viewer. Admin access is required. The request captures the operator profile and routing settings up front; null maxConcurrentChats means unlimited. If the email already belongs to a user, the request creates a membership and organization-scoped operator profile. Otherwise it creates the user, membership, and operator record.
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.
Request 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
{ "success": true}Request examples
curl
curl --request POST \
'https://api.convor.io/api/operators/invite' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"email": "[email protected]",
"displayName": "Alice Johnson",
"role": "operator",
"maxConcurrentChats": null,
"skills": [
"billing",
"vip"
],
"timezone": "Europe/Warsaw",
"isAcceptingNewConversations": true
}'JavaScript
const response = await fetch("https://api.convor.io/api/operators/invite", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"email": "[email protected]",
"displayName": "Alice Johnson",
"role": "operator",
"maxConcurrentChats": null,
"skills": [
"billing",
"vip"
],
"timezone": "Europe/Warsaw",
"isAcceptingNewConversations": true
}),
});
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?