How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoca Frontdesk Onboarding API

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

Zoca Frontdesk Onboarding API is one of 193 APIs that Zoca publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Frontdesk Onboarding. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 54 operations across 48 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 3.20.9.

Requests are made against a single base URL, https://tasks.zoca.ai.

54 operations 48 paths 1 schemas 2 DELETE22 GET6 PATCH21 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.20.9
Base URL
https://api.zoca.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Zoca Frontdesk Onboarding API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (access-token). By default, every request must be authenticated.

  • access-token — Enter JWT token in the format Bearer

Paths & Operations 54

Across 48 paths, the API surfaces 54 operations — 2 DELETE, 22 GET, 6 PATCH, 21 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

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

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is e (5 properties). Each schema is shown below with its type and property counts.

e
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoca-frontdesk-onboarding-api-openapi.yml Raw ↑

Other APIs Zoca publishes across the network.

Zoca ACM API
Zoca Acuity API
Zoca Addon Groups API
Zoca Addons API
Zoca Aeo Lead Magnet API
Zoca Agents API
Zoca API Keys API
Zoca App API
Zoca App Blocker API
Zoca App Blocker Updates API
Zoca Approvals API
Zoca Auth API
Where this information came from

This is an independent, third-party profile of Zoca Frontdesk Onboarding API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.