API reference.

Messaging

• conversations

  The primary object. Threaded history between a visitor and your team.

  list, get, create, update, resolve, reopen, assign

• messages

  Individual messages inside a conversation. Supports visitor, agent, and AI senders.

  list, get, create, update, delete

• conversationNotes

  Internal notes on a conversation. Not visible to visitors.

  list, create, update, delete

• conversationMetadata

  Key/value metadata attached to a conversation.

  get, set

• quickReplies

  Reusable reply templates shown in the composer.

  list, create, update, delete

• cannedResponses

  Canned responses, scoped to the workspace or a team.

  list, create, update, delete

Visitors & identity

• customerProfiles

  People the messenger has seen. Merges anonymous and identified sessions.

  list, get, update, merge

• blockedVisitors

  Per-visitor blocks with audit trail.

  list, block, unblock

• segments

  Dynamic groups of customers defined by attributes and behaviour.

  list, get, create, update, delete

Workflow

• tickets

  First-class ticket objects separate from conversations.

  list, get, create, update, resolve, close

• ticketTypes

  Configured ticket categories.

  list, create, update, delete

• tags

  Labels applied to conversations and tickets.

  list, create, update, delete

• macros

  One-click multi-action scripts.

  list, create, run, update, delete

• automations

  Event-triggered automations. The webhook dispatcher lives here.

  list, create, update, enable, disable, delete

• workflows

  Multi-step automations with branching.

  list, create, update, delete

• autoSnoozeRules

  Rules that snooze conversations based on conditions.

  list, create, update, delete

• routing

  Assignment rules that route new conversations to the right agent or team.

  preview, assign

• sla

  Service-level policies measured against first response, resolution, and update times.

  list, get, upsert, delete

Teams & users

• users

  Agents and admins in the workspace.

  list, get, invite, update, deactivate

• team

  Teams and membership.

  list, create, update, delete

• teamInboxes

  Shared inboxes scoped to a team.

  list, create, update, delete

• organizations

  The workspace itself.

  get, update

• apiKeys

  Personal and service API keys. Secrets are only ever returned once.

  list, create, revoke

AI & knowledge

• ai

  On-demand AI assistance inside the composer.

  draft, answer, handoff

• aiAgents

  Named AI personas bound to a knowledge base.

  list, create, update, run, delete

• aiSuggestions

  Proactive AI suggestions surfaced to the agent.

  list, accept, dismiss

• aiUsage

  Token and cost usage, aggregated by period.

  summary, series

• knowledgeBase

  Articles and collections that feed the AI and the help centre.

  list, get, create, update, publish, delete

• knowledgeClarifications

  Places where the AI was unsure and an operator clarified.

  list, resolve

Channels & integrations

• channels

  Channel connections — widget, email, WhatsApp, Telegram, and more.

  list, connect, disconnect

• widgets

  Messenger configuration.

  get, update

• email-broadcasts

  Outbound email campaigns.

  list, create, send

• whatsapp-broadcasts

  WhatsApp broadcast lists.

  list, create, send

• whatsapp-templates

  Approved WhatsApp message templates.

  list, sync

• telegram

  Telegram channel integration.

  connect, disconnect

• shopify-integrations

  Shopify store links.

  list, connect, disconnect

• integrations

  All other third-party connections.

  list, connect, disconnect

• webhooks

  Outbound webhook subscriptions.

  list, create, update, delete, test

Analytics

• analytics

  Time-series analytics across the workspace.

  conversations, messages, csat, custom

• dashboard

  The queries that power the operator dashboard.

  overview, kpis, series

• metrics

  Individual named metrics.

  list, get

• usage

  Seat and usage accounting for billing.

  summary, series

• csat

  Customer satisfaction ratings and comments.

  list, summary

• audit

  Audit log of security-relevant events.

  list, get