Zoca

Zoca Frontdesk Onboarding API

The Frontdesk Onboarding API from Zoca — 48 operation(s) for frontdesk onboarding.

GitHub OpenAPI

Operations 54

POST /tasks/api/v1/frontdesk/onboarding/provision Onboard an entity end-to-end against the canonical chain #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/agent-catalogue List curated agent voices available to this entity #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/provider Select voice + optional prompt config for this entity #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/phone-number Purchase a Twilio number for the entity (sync) #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/state-rules/seed-defaults Seed default Frontdesk state-rules for an entity (idempotent) #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/agent Bind the predefined platform agent for the entity #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/agent/adopt Adopt the entity's existing platform agent binding #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/sync Hydrate the entity's wizard state from external Retell + Twilio config #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/import-from-provider One-click "import legacy entity into WIN" — hydrate + rebind phone + repair… #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/repair-agent-webhook Stamp the canonical Frontdesk call-events webhook on the entity's Retell agent #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/teardown Soft teardown — release the phone + mark the product activation inactive #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/release Release the entity's phone from its currently-bound platform #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/booking-platforms Combined booking-platform connection state for an entity #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/booking-platforms/catalogue Booking-platform catalogue available to an entity #
DELETE /tasks/api/v1/frontdesk/onboarding/{entityId}/booking-credentials/{platform} Clear the entity's cached browser-auth credentials for a platform #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/import-phone Import a Twilio number to the entity's bound platform agent #
PATCH /tasks/api/v1/frontdesk/onboarding/platform Stamp platform metadata on entity_agents.attributes #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/status Read canonical-chain state for an entity #
POST /tasks/api/v1/frontdesk/onboarding/agent-context Upsert agent context (l2b.agent_context) for an entity #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/agent-context Read l2b.agent_context for an entity #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/state Read the onboarding state map for an entity #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/verify Cross-check our DB against the provider + Twilio for this entity #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/health Combined activity + follow-up-engine state for the Frontdesk detail page #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/quiet-hours Read the followup quiet-hours window for an entity #
PUT /tasks/api/v1/frontdesk/onboarding/{entityId}/quiet-hours Set the followup quiet-hours window for an entity #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/timezone Read the entity locale (timezone + address + coordinates) #
PATCH /tasks/api/v1/frontdesk/onboarding/{entityId}/timezone Set the entity timezone #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/timezone/suggest Derive a timezone suggestion from the location coordinates #
GET /tasks/api/v1/frontdesk/onboarding/dnd/{clientId} Read a client's Do-Not-Disturb state #
POST /tasks/api/v1/frontdesk/onboarding/dnd/enable Enable Do-Not-Disturb for a client #
POST /tasks/api/v1/frontdesk/onboarding/dnd/disable Disable Do-Not-Disturb for a client #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/handovers Active human handovers for an entity (Frontdesk panel Inbox) #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/twilio/number Comprehensive Twilio IncomingPhoneNumber resource for the panel's Twilio Number… #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/twilio/numbers/available Search Twilio's available-for-purchase inventory (panel Purchase modal) #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/twilio/numbers/account List Twilio numbers already on the account (panel Attach modal) #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/twilio/attach Attach an existing Twilio number to this entity (panel Attach modal) #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/twilio/messaging-service A2P messaging service info + enrollment status for this number #
PATCH /tasks/api/v1/frontdesk/onboarding/{entityId}/twilio/messaging-service Partial update of the A2P messaging service's webhook config (SYSTEM-WIDE) #
PATCH /tasks/api/v1/frontdesk/onboarding/{entityId}/twilio/sms-url Set the per-number Twilio `smsUrl` to an arbitrary URL #
PUT /tasks/api/v1/frontdesk/onboarding/{entityId}/twilio/messaging-service/enrollment Enroll or unenroll this entity's number in the A2P messaging service #
PATCH /tasks/api/v1/frontdesk/onboarding/{entityId}/twilio/voice-config Inline-edit voice + status-callback fields on this entity's Twilio number #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/twilio/sip-trunk This entity's current SIP trunk binding + full trunk config #
PATCH /tasks/api/v1/frontdesk/onboarding/{entityId}/twilio/sip-trunk Bind or unbind a SIP trunk on this entity's number #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/twilio/sip-trunks/available List every SIP trunk on the Twilio account (picker data) #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/conversations Entity-scoped conversation list (Frontdesk panel Conversations tab) #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/followups List followup rows for an entity (ops dashboard) #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/followups/sweep Manually trigger a follow-up sweep #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/followups/{followupId}/send-now Dispatch one queued followup immediately #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/followups/{followupId}/deactivate Deactivate a single queued followup #
GET /tasks/api/v1/frontdesk/onboarding/{entityId}/followup-rules List follow-up rules for an entity #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/followup-rules Create a follow-up rule for an entity #
PUT /tasks/api/v1/frontdesk/onboarding/{entityId}/followup-rules/{ruleId} Update a follow-up rule #
DELETE /tasks/api/v1/frontdesk/onboarding/{entityId}/followup-rules/{ruleId} Delete a follow-up rule #
POST /tasks/api/v1/frontdesk/onboarding/{entityId}/twilio-webhooks/sync Repoint Twilio inbound-SMS webhook at the Frontdesk path #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/zoca/refs/heads/main/openapi/zoca-frontdesk-onboarding-api-openapi.yml

Other Resources

🔗
Components
https://raw.githubusercontent.com/api-evangelist/zoca/refs/heads/main/components/zoca-components.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/zoca-frontdesk-onboarding-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zoca-frontdesk-onboarding-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Zoca Tasks Frontdesk Onboarding API
  description: 'The Zoca tasks/automation service: AI content queue and planning, FrontDesk (Retell/Twilio) voice + SMS agent onboarding, local-SEO grid scans, WIN conversion triggers, and inbound integration webhooks (Chargebee, Square, Pipedrive, Twilio, Retell, CallHippo, Sybill, Instantly).'
  version: 3.20.9
  contact: {}
  x-apievangelist-note: Harvested verbatim from https://tasks.zoca.ai/swagger.json. The provider ships the default NestJS Swagger metadata (title "API Documentation", empty servers[]); title/description/servers were set by API Evangelist for identification and the unmodified original is preserved at openapi/_original/zoca-tasks-swagger.json. Every path, operation, summary, parameter and response is exactly as published.
servers:
- url: https://tasks.zoca.ai
  description: Production
security:
- access-token: []
tags:


# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoca/refs/heads/main/openapi/zoca-frontdesk-onboarding-api-openapi.yml