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 Win Onboarding API

The Win Onboarding API from Zoca — 37 operation(s) for win onboarding.

Zoca Win 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 Win Onboarding. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 39 operations across 37 paths, and defines 2 schemas. 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.

39 operations 37 paths 2 schemas 14 GET2 PATCH19 POST4 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 Win 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 39

Across 37 paths, the API surfaces 39 operations — 14 GET, 2 PATCH, 19 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Win Onboarding 39
POST
/tasks/api/v1/win-onboarding
Start Win Onboarding Process
t_value body → 201
POST
/tasks/api/v1/win-onboarding/create-chatbot-entity
Create Chatbot Entity
postTasksApiV1WinOnboardingCreateChatbotEntity body → 201
POST
/tasks/api/v1/win-onboarding/create-virtual-number
Create Virtual Number
postTasksApiV1WinOnboardingCreateVirtualNumber body → 201
POST
/tasks/api/v1/win-onboarding/retry-virtual-number
Retry Virtual Number Purchase
postTasksApiV1WinOnboardingRetryVirtualNumber body → 201400
POST
/tasks/api/v1/win-onboarding/import-retell
Import to Retell
postTasksApiV1WinOnboardingImportRetell body → 201
POST
/tasks/api/v1/win-onboarding/provision-phone-number
Provision phone number (async)
postTasksApiV1WinOnboardingProvisionPhoneNumber body → 201
GET
/tasks/api/v1/win-onboarding/phone-provisioning/{jobId}
Phone provisioning job status
getTasksApiV1WinOnboardingPhoneProvisioningByJobId 1 param → 200
POST
/tasks/api/v1/win-onboarding/build-context
Build Context from Website
postTasksApiV1WinOnboardingBuildContext body → 201
GET
/tasks/api/v1/win-onboarding/status/{entityId}
Get Win Onboarding Status
getTasksApiV1WinOnboardingStatusByEntityId 1 param → 200404
GET
/tasks/api/v1/win-onboarding/context/{entityId}
Get context data for entity
getTasksApiV1WinOnboardingContextByEntityId 1 param → 200
POST
/tasks/api/v1/win-onboarding/retell/incoming-call
Handle incoming call webhook from Retell
postTasksApiV1WinOnboardingRetellIncomingCall body → 200
POST
/tasks/api/v1/win-onboarding/retell/call-events
Handle call events webhook from Retell
postTasksApiV1WinOnboardingRetellCallEvents body → 200
GET
/tasks/api/v1/win-onboarding/client-history/{clientId}
Get client call history
getTasksApiV1WinOnboardingClientHistoryByClientId 1 param → 200404
GET
/tasks/api/v1/win-onboarding/entity-call-history/{entityId}
Get entity call history
getTasksApiV1WinOnboardingEntityCallHistoryByEntityId 4 params → 200404
GET
/tasks/api/v1/win-onboarding/call/{callId}
Get call history by call ID
getTasksApiV1WinOnboardingCallByCallId 1 param → 200404
PATCH
/tasks/api/v1/win-onboarding/call/{callId}/mark-test
Mark call as test
patchTasksApiV1WinOnboardingCallByCallIdMarkTest 1 param → 200404
GET
/tasks/api/v1/win-onboarding/user/{userEntityId}/locations
Get user info and locations onboarding status
getTasksApiV1WinOnboardingUserByUserEntityIdLocations 1 param → 200
GET
/tasks/api/v1/win-onboarding/voice-agents/{entityId}
Get available voice agents (platform-aware) for a location
getTasksApiV1WinOnboardingVoiceAgentsByEntityId 1 param → 200
GET
/tasks/api/v1/win-onboarding/area-codes/{areaCode}/alternates
Get alternate area codes
getTasksApiV1WinOnboardingAreaCodesByAreaCodeAlternates 1 param → 200
GET
/tasks/api/v1/win-onboarding/agent-context/{entityId}
Get agent context for entity
getTasksApiV1WinOnboardingAgentContextByEntityId 1 param → 200404
PUT
/tasks/api/v1/win-onboarding/agent-context/{entityId}
Update agent context for entity
putTasksApiV1WinOnboardingAgentContextByEntityId 1 param body → 200400
POST
/tasks/api/v1/win-onboarding/agent-context
Create agent context
postTasksApiV1WinOnboardingAgentContext → 201400
POST
/tasks/api/v1/win-onboarding/agent-context/migrate
Queue job to migrate agent context from legacy table to l2b
postTasksApiV1WinOnboardingAgentContextMigrate → 200400
PUT
/tasks/api/v1/win-onboarding/callback/status
Update callback status
putTasksApiV1WinOnboardingCallbackStatus body → 200404
GET
/tasks/api/v1/win-onboarding/callback/statuses
Get available callback statuses
getTasksApiV1WinOnboardingCallbackStatuses → 200
GET
/tasks/api/v1/win-onboarding/callbacks/{entityId}
Get all callbacks for entity
getTasksApiV1WinOnboardingCallbacksByEntityId 4 params → 200
POST
/tasks/api/v1/win-onboarding/retell-call-sync
Sync call data from Retell
postTasksApiV1WinOnboardingRetellCallSync body → 201400
POST
/tasks/api/v1/win-onboarding/retell-call-sync/bulk
Bulk sync call data from Retell
postTasksApiV1WinOnboardingRetellCallSyncBulk body → 201400
POST
/tasks/api/v1/win-onboarding/quick-setup
Quick setup - prepare agent context from existing data
postTasksApiV1WinOnboardingQuickSetup body → 201400404
POST
/tasks/api/v1/win-onboarding/feedback
Create WIN feedback
postTasksApiV1WinOnboardingFeedback body → 201400
GET
/tasks/api/v1/win-onboarding/feedback/{entityId}
Get WIN feedback for entity
getTasksApiV1WinOnboardingFeedbackByEntityId 2 params → 200
PATCH
/tasks/api/v1/win-onboarding/feedback/{id}
Update WIN feedback
patchTasksApiV1WinOnboardingFeedbackById 1 param body → 200404
PUT
/tasks/api/v1/win-onboarding/status
Update WIN onboarding status
putTasksApiV1WinOnboardingStatus body → 200404
POST
/tasks/api/v1/win-onboarding/reach-out-list
Create or update reach-out list entry
postTasksApiV1WinOnboardingReachOutList body → 201400
POST
/tasks/api/v1/win-onboarding/publish-virtual-number-to-gbp
Publish virtual number to Google Business Profile
postTasksApiV1WinOnboardingPublishVirtualNumberToGbp body → 200400
POST
/tasks/api/v1/win-onboarding/publish-virtual-number-to-all
Publish virtual number to GBP and Website
postTasksApiV1WinOnboardingPublishVirtualNumberToAll body → 200400
GET
/tasks/api/v1/win-onboarding/preferences/{entityId}
Get frontdesk booking preferences
getTasksApiV1WinOnboardingPreferencesByEntityId 1 param → 200
PUT
/tasks/api/v1/win-onboarding/preferences/{entityId}
Update frontdesk booking preferences
putTasksApiV1WinOnboardingPreferencesByEntityId 1 param → 200
POST
/tasks/api/v1/win-onboarding/preferences/{entityId}/sync
Sync frontdesk preferences from integrated platform
postTasksApiV1WinOnboardingPreferencesByEntityIdSync 1 param → 200

Schemas 2

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

t
object
13 properties 6 required
e
object
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Zoca publishes across the network.

Zoca ACM API
Zoca Acuity API
Zoca Addon Groups 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
Zoca Billing API
Where this information came from

This is an independent, third-party profile of Zoca Win 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.