API ReferenceOperators
Operators
Operator management
Operator management
Endpoints
POSTBulk-update operator availability status — Updates the availability status for multiple operators in the current organization. Admin access is required.POSTCreate an operator — Creates an unlinked operator record in the authenticated organization. Admin access is required.GETGet operator availability schedule — Returns an operator's canonical seven-day recurring availability schedule and timezone, including split and overnight ranges.GETGet operator statistics — Returns performance statistics for an operator in the authenticated organization.GETGet the operator leaderboard — Returns a ranked leaderboard of operators in the current organization.POSTInvite an operator to the organization — Invites a user to the authenticated organization as an operator, admin, or viewer. Admin access is required.GETList operators and their status — Lists operators in the authenticated organization together with their profile, presence status, and active conversation counts.DELETERemove an operator from the organization — Removes an operator from the authenticated organization. Admin access is required.PUTUpdate operator availability schedule — Updates an operator's seven-day recurring availability schedule and optional timezone.PATCHUpdate operator settings — Partially updates an operator's assignment settings in the authenticated organization. Admin access is required.PATCHUpdate operator status — Updates an operator's presence status in the authenticated organization. Admin access is required. The update also refreshes the operator's last-seen timestamp.
Was this page helpful?