Skip to content
oHallo Developers
Search
Ctrl
K
Cancel
Overview
Introduction
Core Concepts
Authentication
Using the API
API Conventions
Brands
Conversations
Cases
Contacts and Accounts
Knowledge Base
Policies
Agents
Quality and CSAT
Consumption
Calendar and Bookings
Widgets
Channels
MCP Connections
Polling for changes
API Reference
Overview
Brands
Overview
List brands
Create a brand
Get a brand
Delete a brand
Update a brand
List a brand's workspaces
Upload a brand logo
Upload the assistant's sender image
Workspaces
Overview
List workspaces
Create a workspace
Get workspace by ID
Delete a workspace
Update a workspace
Conversations
Overview
List conversations
Get conversation by ID
Get messages in a conversation
Get attachments in a conversation
Send a human reply
Resolve a conversation
Start a new outbound conversation
Take over a conversation
Release a conversation back to AI
Assign a conversation to a user
Unassign a conversation
Approve a pending action
Get conversation status counts
List attention items
Resolve an attention item
Get assembled conversation detail
List conversation identity events
Get a conversation audit report
Contacts
Overview
Search contacts
Create a contact
Get contact by ID
Delete a contact
Update a contact
Link a contact to an account
Accounts
Overview
Search accounts
Get account by ID
List contacts for an account
Knowledge Base
Overview
List knowledge base entries
Create a KB entry
Search knowledge base entries
List knowledge base topics
List pending KB entries
Get a KB entry
Delete a KB entry
Update a KB entry
Approve a pending KB entry
Reject a pending KB entry
Get a KB entry version
List KB entry versions
Restore a KB entry version
Policies
Overview
List policy entries
Create a policy entry
Search policy entries
List policy topics
List pending policy entries
Get a policy entry
Delete a policy entry
Update a policy entry
Approve a pending policy entry
Reject a pending policy entry
Get a policy entry version
List policy entry versions
Restore a policy entry version
Agents
Overview
List all agent definitions
List the models an agent can use
List custom agent definitions
Create a custom agent
Delete a custom agent
Update a custom agent
Update agent instructions
List agent executions
List tool calls for an execution
Get an agent definition version
Check whether an agent is reachable in a workspace
List agent definition versions
Restore an agent definition version
Widgets
Overview
List KB widgets
Create a KB widget
Get a KB widget by ID
Delete a KB widget
Update a KB widget
Rotate KB widget public key
List contact form widgets
Create a contact form widget
Get a contact form widget by ID
Delete a contact form widget
Update a contact form widget
Rotate contact form widget public key
Channels
Overview
Check an email channel's DNS records
Get channel by ID
Delete a channel
Update a channel
Store channel credentials
Test channel connectivity
Retry channel provisioning
List channels in a workspace
Create a channel in a workspace
Quality
Overview
Get quality stats
Get conversation quality
Get account health
List circuit breakers
Acknowledge a circuit breaker
Resolve a circuit breaker
Get CSAT configuration
Update CSAT configuration
Get a contact's CSAT history
Billing
Overview
Get conversation statistics
Get agent breakdown
Calendar
Overview
List calendar connections
Get calendar connection
Delete calendar connection
Update calendar connection
List available calendars
Start OAuth flow
List bookings
Cases
Overview
List cases
Get a case
Get a case's events
List case types
MCP Connections
Overview
List MCP connections
Register an MCP connection
Get an MCP connection
Delete an MCP connection
Test an MCP connection
Update a connection’s instructions
Classify a connection’s tools
Assign a connection’s tools to agents
Set the assurance a tool requires
Declare the scope of a tool
List a connection’s guardrails
Add a guardrail
Replace a connection’s guardrails
Delete a guardrail
Update a guardrail
List a connection’s versions
Get one version
Restore a version
Remove an agent's access to a connection
MCP Servers
What is MCP?
The oHallo MCP server
Connecting an MCP client
Build an MCP Server
Tool Schema
Example: Shipping Tracker
Testing and Debugging
Guardrails
Integrations
HubSpot
Identity and Verification
Overview
The customer lookup contract
Returning a national identity number
Authoring MCP tools for verification
Identity event schema
Lockout notification email template
Guides
Quickstart
Managing the Knowledge Base
Building a Custom Agent
Embedding Widgets
Overview
Copy as Markdown
Copied
Brands
Section titled “Brands”
Create and manage brands, the level above workspaces.
