main as reviewed on November 16, 2026. Availability depends on the deployed release, environment flags, workspace permissions, and provider readiness. A documented endpoint is not a claim that its feature is enabled in Production.
Choose an interface
Paths beginning with
/v1 use the API host. The application-domain /v1 and /mcp aliases remain supported. There is no /api prefix on the public contract. Use an environment’s own service document and OpenAPI server URLs when testing outside Production.
The public OpenAPI document covers public /v1 product routes. Mobile /mobile/v1, legacy /v1/auth and /v1/projects, browser privacy-consent routes, provider webhooks, and the private dashboard Assistant delegation endpoint /mcp/assistant have separate application-specific contracts. They are not general-purpose integration entry points.
Find the current contract
Use
contactbutton_get_page_manifest for a workspace Page manifest and contactbutton_get_profile for a public Page profile. The current MCP servers expose these through tools; do not depend on the older contactbutton://pages/{page_id}/manifest resource URI.
What REST covers
- Setup and content: workspaces, teams, settings, revisioned onboarding, Pages and domains, Buttons and templates, Apps, Forms, Lists, Surveys, and Knowledge.
- Agents: effective controls, profiles, ordered rules, knowledge assignments and gaps, handoff policies, and deterministic automations. Use the dedicated routes and their feature gates.
- Inbox: Contact-centric threads, messages, attachment upload/download/deletion, channel connections, templates, follow-ups, and confirmed workspace bookings. Read Conversations API.
- Calling: telephony readiness, call flows, numbers, voice interactions, and browser dialer sessions. Session creation returns temporary credentials and intentionally bypasses REST idempotency replay. Read Telnyx.
- Reviews: destinations, connected locations, cursor-paginated reviews, provider reply updates/deletion, and consented review requests. Read Reviews.
- Commerce: offers, support Apps, Stripe Connect onboarding, payments, creator reports, membership subscriptions, and supporter replies. Read Creator commerce. Both commerce and public-checkout gates must be enabled for visitor payment creation.
- Public surfaces: Agent and native Chat conversations, attachments and callback capture, Page action proposals, Surveys, Knowledge, Questions, Answer Widgets, and Review Widgets. Public visibility is checked independently of knowing a UUID.
Permissions, retries, and confirmation
Use the scope table to select a key. A scope grants an operation only inside workspaces the caller may access. MCP OAuth also requires an active grant for the selected workspace and the canonical MCP audience; these tokens are not REST API keys. Send a uniqueIdempotency-Key for supported REST mutations and preserve the exact request for retries. Some endpoints require it; others accept it. File uploads and browser call sessions need their own retry handling. MCP setup and Inbox writes use a UUID request_id; public proposal tools use idempotency_key. Older MCP creation tools retain their original schemas and do not provide the new receipt contract.
Public MCP and A2A material actions return a Contact Button review_url. The visitor reviews and verifies on Contact Button; external clients cannot approve themselves or obtain the OTP. Authenticated Inbox booking tools instead act with the workspace operator’s authority, reserve a slot immediately, and queue connected-calendar synchronization. Show the operator the requested action before calling a write tool.
See MCP servers, Agent protocol parity, Human confirmation, and Rollout for the detailed boundaries.