Zoca App API
Endpoints consumed by the mobile App
Zoca App API is one of 193 APIs that Zoca publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include App. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 312 operations across 274 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 3 base URLs: https://api.zoca.ai, https://public.zoca.com, https://tasks.zoca.ai.
312 operations
274 paths
5 schemas
15 DELETE178 GET9 PATCH69 POST41 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zoca App API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (access-token).
access-token— Enter JWT token in the format Bearer
Paths & Operations 312
Across 274 paths, the API surfaces 312 operations — 15 DELETE, 178 GET, 9 PATCH, 69 POST, 41 PUT. Each is listed below with its method, path, parameters, and response codes.
App 312
Endpoints consumed by the mobile App
GET
/business-profile
Get business profile information by entity Id
GET
/business-profile/primary-category-suggestion
Get primary category suggestions
GET
/business-profile/additional-category-suggestion
Get additional category suggestions
PUT
/business-profile/additional-category-suggestion
Get additional category suggestions (v2)
GET
/business-profile/booking-platforms
Get all booking platforms
GET
/business-profile/social-platforms
Get all social media platforms
PUT
/business-profile/{entityId}/booking-link
Update booking link for a platform
GET
/business-profile/{entityId}/booking-link
Update booking link for a platform
PUT
/business-profile/update-profile-data
Update business profile data
PUT
/business-profile/website-domain/{entityId}
Update website domain data
PUT
/business-profile/website-domain-quotation/{entityId}
Get domain quotation
GET
/webview
Get webviews by query parameters
GET
/app-blocker/updates/{id}
Get update by ID
DELETE
/app-blocker/updates/{id}
Delete an app blocker update
GET
/auth/check
Check authentication status
GET
/auth/google-auth-url
Google Authentication URL
GET
/auth/square/authorize
Square OAuth Authorization URL
GET
/auth/instagram/authorize
Instagram OAuth Authorization URL
GET
/auth/tiktok/authorize
TikTok OAuth Authorization URL
POST
/auth/magic-link/verify
Verify a magic link token and get auth tokens
GET
/campaigns/requests
List campaign requests for an entity
POST
/campaigns/requests
Create a new campaign request
PATCH
/campaigns/requests
Update a campaign request
GET
/campaigns/requests/count
Get campaign request counts by status
GET
/campaigns/requests/{id}
Get a campaign request by ID
DELETE
/campaigns/requests/{id}
Delete a campaign request
GET
/campaigns/suggestions
List all campaign suggestions
GET
/campaigns/flyers
List all campaign flyers
GET
/chatbot/calls/{callId}
Get call details by call ID
GET
/chatbot/calls/{callId}/regenerate-summary
Regenerate call summary by call ID
PUT
/chatbot/retell/phone/{phoneNumber}
Update a phone number configuration
POST
/chatbot/phone/purchase
Purchase a new phone number
POST
/chatbot/feedback
Create a new feedback record
GET
/chatbot/feedback
Get all feedback records for an entity with pagination
PUT
/chatbot/feedback/{id}
Update an existing feedback record
GET
/chat/conversations
Get conversations list or single conversation details
POST
/chat/message
Create a new message in a conversation
PUT
/chat/message
Update message text or soft delete
POST
/chat/reaction
Add reaction to a message
PUT
/chat/reaction
Update or soft delete a reaction
POST
/chat/message-receipt
Mark messages as read in a conversation
POST
/clients
Create a new client with contact information
POST
/clients/bulk
Bulk create clients with contact information
POST
/clients/bulk-s3
Bulk import clients from S3 URL
GET
/clients/entity/{entityId}
Get clients by entity ID with pagination
PUT
/clients/block
Block or restore clients
GET
/clients/entity/{entityId}/blocked
Get blocked clients for an entity with pagination
GET
/clients/{clientId}
Get a client by ID
POST
/clients/{entityId}/clientFile
Store a client file for an entity
GET
/clients/comm-types
Get available communication types
PATCH
/clients/comms/{commId}/status
Update communication status
GET
/booking-enquiries
List all booking enquiries with pagination and filters
GET
/booking-enquiries/sources
List distinct enquiry sources for an entity (source filter options)
GET
/booking-enquiries/enquiry-status
Get enquiry status statistics for an entity
GET
/booking-enquiries/{entityId}/search
Search clients by name, number, or query
GET
/booking-enquiries/enquiry-stats
Get detailed enquiry statistics for an entity
GET
/booking-enquiries/multilocation/{businessEntityId}
List enquiries across all locations of a business with network stats
GET
/booking-enquiries/{enquiryId}/enquiry
Get enquiry details by ID
PUT
/booking-enquiries/{enquiryId}/status
Update enquiry status with reason and services
POST
/booking-enquiries/{clientId}/notes
Add a note to a client
GET
/booking-enquiries/{clientId}/notes
Get all notes for a client
GET
/booking-enquiries/{clientId}/enquiries
Get all enquiries for a client with status filter
PUT
/booking-enquiries/notes/{noteId}
Update an existing client note
DELETE
/booking-enquiries/notes/{noteId}
Delete a client note
POST
/booking-enquiries/{clientId}/communication-logs
Add communication log for a client
POST
/booking-enquiries/client-conversation
Add a conversation message for a client
GET
/booking-enquiries/{clientId}/app/chat
Get chat data for mobile app
GET
/booking-enquiries/{clientId}/summary
Get summary of client interactions
GET
/booking-enquiries/{entityId}/text-templates
List all text templates for an entity
PUT
/booking-enquiries/text-templates/{templateId}
Update an existing text template
PUT
/booking-enquiries/{entityId}/text-template-preferences
Update text template preferences
GET
/booking-enquiries/{entityId}/text-template-preferences
Get text template preferences for an entity
PUT
/booking-enquiries/formatted-text-template
Format text template with client data
GET
/booking-enquiries/{entityId}/automated-text-templates
Get default lead communication templates
PUT
/booking-enquiries/{entityId}/automated-text-templates
Update lead communication templates
GET
/booking-enquiries/{locationEntityId}/automated-text-templates/variables
Get lead communication template variable values
GET
/booking-enquiries/automated-text-templates/variables
Get available automated communication variables
GET
/booking-enquiries/{entityId}/automated-text-templates/preferences
Get automated communication template preferences
PUT
/booking-enquiries/{entityId}/automated-text-templates/preferences
Update automated communication template preferences
GET
/booking-enquiries/{entityId}/text-template-order
Get text template order for a client
GET
/booking-enquiries/conversation-activity
Get conversation activity details for a client or enquiry
GET
/booking-enquiries/client-conversations
Get client conversations including SMS and calls
GET
/entities/locations
Get all locations for a user
POST
/entities/onboarding-state
Update onboarding state for an entity
PUT
/entities/location/{entityId}
Update location data
GET
/entities/location/{entityId}/details
Get essential location details
GET
/entities/location/{entityId}/rwg-status
Get Reserve with Google status
GET
/entities/{entityId}/more-tab-cards
Get visibility markers for More tab cards
GET
/entities/products/{entityId}
Get products for an entity
PUT
/entities/products/{entityId}
Create or update a product entity relationship
POST
/entities/{entityId}/preferences
Create or update an entity preference
GET
/entities/location/{entityId}/booking-link
Get booking link for a location
PUT
/entities/location/{entityId}/booking-link
Update booking link for a location
GET
/entities/offboarding-reason-templates
Get active offboarding reason templates
GET
/entities/offboarding/active-subscriptions/v2/{entityId}
Get active subscriptions and offboarding information for an entity (with…
POST
/entities/{entityId}/trigger-payment-link-comms
Trigger payment link communications for an entity
POST
/entities/{entityId}/review-insights
Get review insights for an entity
GET
/entities/{entityId}/hubspot/meetings
Get upcoming HubSpot meetings for an entity
POST
/events
Handle incoming event from Lambda
GET
/features
Get all available features for an entity based on active products
GET
/features/insights-tabs
Get Insights tabs with URLs based on active products
GET
/gbp-location/list
List all locations for entity
POST
/gbp-location/create
Onboard a gbp location for entity
GET
/gbp-location/posts/list
List posts for location
GET
/gbp-location/posts
Get a single post by name
PATCH
/gbp-location/posts
Update a post
DELETE
/gbp-location/posts
Delete a post
GET
/gbp-location/keyword-impression-insights
Get keyword impression insights for a location
GET
/gbp-location/performance-insights
Get performance insights for location
GET
/google-maps/place-auto-complete
Get place autocomplete suggestions
GET
/google-maps/place-id-details
Get place details by place ID
GET
/homepage/activation-steps
Get activation steps status
GET
/homepage
Get homepage data
GET
/homepage/homepage-components
Get homepage components
GET
/homepage/activation-steps-data
Get activation steps data
GET
/homepage/check-website-status
Check website status
GET
/homepage/monthly-report
Get monthly report(s) for an entity
PUT
/homepage/monthly-report
Update monthly report status
GET
/homepage/referrals/link/{businessEntityId}
Get referral link for business
POST
/homepage/referrals
Create a referral
GET
/homepage/carousel-cards
Get carousel cards for Win Agent onboarding
GET
/homepage/discovery-metrics
Get cumulative discovery metrics since onboarding
POST
/media
Create a new media
GET
/media
Get all media
DELETE
/media
Delete a media
GET
/media/scheduled-media
Get scheduled media for a location
GET
/media/logo-and-cover-image
Get logo and cover image for a location
POST
/media/log-failed-media-time
Log failed media upload time
GET
/meta/business-discovery
Get Instagram business discovery data
GET
/meta/media
Get all media for a specific Instagram business account
POST
/meta/connect-instagram
Connect an Instagram business account to a location entity
POST
/meta/upload-media
Upload selected media to specified destinations
GET
/meta/account-status
Check if an Instagram business account is already connected to a location entity
POST
/meta/disconnect-instagram
Disconnect an Instagram business account from a location entity
GET
/tiktok/videos
Get user's TikTok videos
GET
/tiktok/creator-info
Get TikTok creator information for publishing
POST
/offers/draft
Create a draft offer with optional fields
PUT
/offers/{id}/draft
Update a draft offer with field-by-field updates
GET
/offers/{id}
Get offer details
DELETE
/offers/{id}
Soft delete an offer
GET
/offers/channels/{entityId}
List available channels for offer creation with publishOn dates
POST
/offers/description/generate
Generate AI-powered description for an offer
POST
/offers/description/validate
Validate AI-powered description for an offer
GET
/offers/entities/{entityId}/status
List all offers on an entity with status
GET
/offers/entities/{entityId}/status/count
Get count of offers grouped by status for an entity
GET
/offers/entities/{entityId}/search
Search offers by title with status calculation
GET
/offers/{offerId}/suggestions
Get suggestions for an offer
GET
/onboarding/app-visitor
Register app visitor
POST
/onboarding/update-user
Update User Profile
GET
/onboarding/onboarding-state
Get onboarding state for entity
GET
/onboarding/user-profile
Get user profile information
GET
/onboarding/quick-recap
Get onboarding quick recap pointers
GET
/onboarding/business-categories
Get list of business categories
GET
/onboarding/customer-sources
Get list of customer sources
GET
/onboarding/search-booking-link
Search for booking platform link
GET
/onboarding/check-platform-selection/{locationEntityId}
Check if specific platforms were selected during onboarding within 10 hours
POST
/onboarding/trigger-comms
Trigger onboarding communications for MoEngage notifications
POST
/pipedrive/person/upsert
Create Pipedirve Person
POST
/pipedrive/organization/upsert
Create Pipedirve Organization
GET
/pipedrive/lead/status
Get Lead Status
GET
/pipedrive/lead/callback
Requested a callback
POST
/requests-api/fromTemplate
Create a request from a template
DELETE
/requests-api/{id}
Delete a request by ID
PUT
/requests-api/{id}
Update a request by ID
GET
/requests-api/{entityId}/list
List requests for an entity with optional pagination
POST
/requests-api/filters
Filter requests excluding specified types
PATCH
/requests-api/{id}/additionalData
Patch additional data for a request
GET
/requests-api/categories/{entityId}
Get ticket categories for an entity
GET
/services-sync/request
Get current sync request for a location
POST
/services-sync/resync/request
Create a resync request
GET
/review-invites/client-sources
Get available client sources for an entity
GET
/review-invites/clients
Get clients filtered by source with pagination
GET
/review-invites/client-phone
Get client phone numbers for an entity
GET
/review-invites/search-clients
Search clients by term with pagination
GET
/review-invites/text-templates
Get SMS text templates for review invites
PUT
/review-invites/text-templates/{templateId}
Update a text template by ID
GET
/review-invites/invites-status
Get all invite status counts for an entity
GET
/review-invites/invites-by-status
Get invites filtered by status with pagination
POST
/review-invites/{entityId}/invite
Send review invites to clients
DELETE
/review-invites/{entityId}/invite
Delete a review invite
POST
/review-invites/{entityId}/invite-reminder
Send review invite reminders to clients
GET
/review-invites/qr-code
Get QR code for review invites
PUT
/review-invites/formatted-text-template
Format a text template with client data
POST
/review-invites/email-ra-optin
Store email review automation opt-in status
GET
/review-invites/email-ra-optin
Get email review automation opt-in status
GET
/review-invites/review-link
Get the review link for a location
GET
/reviews/{entityId}/reviews
Get paginated reviews for an entity
GET
/reviews/review-id
Get review by ID
POST
/reviews/{reviewId}/reply
Create a reply to a review
PUT
/reviews/{reviewId}/reply
Update a review reply
DELETE
/reviews/{reviewId}/reply
Delete a review reply
GET
/reviews/stats
Get review statistics
POST
/reviews/{entityId}/preferences
Set review preferences
GET
/reviews/{entityId}/preferences
Get review preferences
GET
/reviews/{entityId}/app/gbp-component
Get Google Business Profile component data
GET
/reviews/{entityId}/app/card
Get review cards for app dashboard
GET
/scheduling/bookings/{id}
Get booking by ID with aggregated data
GET
/scheduling/onboarding/{entityId}/{locationEntityId}/status
Get onboarding status for an entity and location
POST
/scheduling/stripe/terminal/connection-token
Create Stripe Terminal connection token
GET
/scheduling/stripe/terminal/tap-to-pay-config
Get Tap to Pay configuration
POST
/scheduling/stripe/terminal/ensure-location
Provision Stripe Terminal location for a connected account
GET
/scheduling/checkout-tip-config
List checkout tip presets for a location
POST
/scheduling/checkout/pay
Process a payment for a sale
POST
/scheduling/checkout/processing-fee-quote
Quote checkout processing fee
PATCH
/scheduling/checkout/sale/{saleId}/tip
Update the tip on a sale
POST
/scheduling/checkout/cancel-payment/{paymentId}
Cancel a payment
GET
/services/service/{id}
Get service by ID
PUT
/services/service/{id}
Update service
DELETE
/services/service/{id}
Delete service
POST
/services/{entityId}/service
Create a new service
POST
/services/categorydeprecated
Create a new category (deprecated)
GET
/services/category/{id}
Get a category by ID
PUT
/services/category/{id}
Update a category
DELETE
/services/category/{id}
Delete a category
GET
/services/{entityId}/categories
Get all categories for an entity
POST
/services/service/{serviceId}/category/{categoryId}
Assign a service to a category
DELETE
/services/service/{serviceId}/category/{categoryId}
Remove a service from a category
PUT
/services/reorder-categories-services
Reorder categories and their services
GET
/services/{serviceId}/images
Get all images for a service
POST
/services/{serviceId}/images
Add a new image to a service
DELETE
/services/{serviceId}/images/{imageId}
Delete an image from a service
PUT
/services/variation/{id}
Update a variation
DELETE
/services/variation/{id}
Delete a variation
GET
/services/service/{serviceId}/variations
Get variations for a service
POST
/services/service/{serviceId}/variation
Create a new variation
POST
/services/{entityId}/categories-with-services
Create categories with services
PUT
/services/variations/batch
Batch update variations
GET
/services/{entityId}/categories/suggested
Get suggested categories
GET
/services/{entityId}/{categoryId}/suggested
Get suggested services for an entity and category
GET
/services/{entityId}/categories/suggested-services
Get suggested services for all categories
GET
/services/{entityId}/categories/check-duplicate
Check for duplicate category name
POST
/social-media/update-caption
Update post caption
POST
/social-media/get-feed-posts
Get feed posts with pagination
GET
/social-media/get-instagram-post
Get Instagram post by ID
POST
/social-media/add-feedback-to-post
Add feedback to a post
GET
/social-media/get-feedback-for-post
Get feedback for a post
PUT
/social-media/remove-feedback-from-post
Remove feedback from a post
GET
/social-media/get-user-insta-details
Get user Instagram details
PUT
/social-media/set-user-insta-details
Set user Instagram details
GET
/social-media/get-user-overdue-count
Get user overdue post count
PUT
/social-media/approve-all-posts-by-uid
Approve all posts by user ID
PUT
/social-media/set-user-post-status
Set user post status
PUT
/social-media/approve-user-overdue-post-status
Approve user overdue post status
GET
/social-media/get-all-posting-dates-for-month
Get all posting dates for a month
GET
/social-media/get-preference-request
Get preference update request status
PUT
/social-media/put-preference-request
Update preference request status
POST
/social-media/add-instagram-post-rejection-reason
Add Instagram post rejection reason
GET
/square/locations/{entityId}
Get Square locations by entity ID
GET
/ui-components
Get UI component by ID or get all components
PATCH
/updates/{id}
Patch an update record
GET
/updates/entity/{entityId}
Get all updates for a specific entity
PATCH
/updates/entity/{entityId}
Mark all updates as read for a specific entity
GET
/updates/count/{entityId}
Get the count of updates for a specific entity
POST
/website/add-booking-link
Add booking link and trigger website creation
GET
/website/onboarding-creation-status
Get onboarding website-creation status
GET
/website/generate-website
Generate website for a location
GET
/website/platforms
Get available booking platforms
GET
/website/templates
Get templates, optionally filtered by website ID
GET
/website/section-media
Get section media data
POST
/website/replace-media-in-section
Replace media in section
POST
/website/save-theme-template
Save selected theme and template
POST
/website/{websiteId}/themes/generate-palette
Generate AI color palettes from a prompt
GET
/website/{websiteId}/ai-colors
List a website's AI-generated color palettes
DELETE
/website/{websiteId}/ai-colors/{id}
Delete an AI-generated color palette
POST
/website/{websiteId}/ai-colors/{id}/persist
Persist a stored AI palette as a theme (returns themeId)
POST
/website/{websiteId}/ai-colors/{id}/apply
Apply a stored AI palette to the website and publish
GET
/website/{websiteId}/theme-template
Get theme and template for website
POST
/website/reorder-media-in-section
Reorder media in section
GET
/website/get-website-status
Get website status and preferences
GET
/website/subdomain
Get website subdomain
PUT
/website/subdomain
Update website subdomain (preserves current domain)
GET
/website/subdomain-validate
Validate subdomain availability
POST
/website/add-user-preferences
Add user preferences
POST
/discovery/aeo-reports/{auditRunId}/custom-prompts
Add a user custom prompt to an existing AEO report
GET
/discovery/{locationEntityId}/impact-nudges
Get impact nudges for a location entity
GET
/discovery/{locationEntityId}/gbp/metrics
Get GBP analytics metrics for a location
GET
/discovery/{locationEntityId}/gbp/optimization-score
Get GBP Optimization Score for a location
GET
/discovery/{locationEntityId}/website/metrics
Get website metrics for a location
GET
/discovery/{locationEntityId}/keyword/performance/metrics
Get zocaweb keyword performance KPI metrics
GET
/discovery/{locationEntityId}/keyword/performance/keywords
Get zocaweb paginated keyword performance rows
GET
/discovery/{locationEntityId}/keyword/performance
Get keyword performance for a location
GET
/discovery/{locationEntityId}/website/optimization-score
Get Website Optimization Score for a location
GET
/discovery/{locationEntityId}/review/metrics
Get review metrics for a location
GET
/discovery/{locationEntityId}/agent-journey/metrics
Get agent journey metrics for a location
GET
/integrations/website/{entityId}/list
List all platforms with link status for an entity
GET
/integrations/{entityId}/{id}
Get platform detail by id
PATCH
/integrations/website/{entityId}/status
Link or unlink a platform for an entity
GET
/hubspot/am-meeting-url/{entityId}
Get AM Meeting URL for Location
GET
/hubspot/offboarding-meeting-url/{entityId}
Get Offboarding Meeting URL for Location
GET
/
Get app data
GET
/r/{alias}
Redirect link by alias
GET
/get-app
Serve app redirect page
GET
/applink
Handle app deep link redirect
GET
/tasks/api/v1/chatbot/l2b/entity-phone-numbers/{entityId}
Get all L2B entity phone numbers
GET
/tasks/api/v1/twilio/phone/search
T value
GET
/tasks/api/v1/win-onboarding/status/{entityId}
Get Win Onboarding Status
GET
/tasks/api/v1/win-onboarding/client-history/{clientId}
Get client call history
GET
/tasks/api/v1/win-onboarding/call/{callId}
Get call history by call ID
GET
/tasks/api/v1/win-onboarding/user/{userEntityId}/locations
Get user info and locations onboarding status
GET
/tasks/api/v1/win-onboarding/voice-agents/{entityId}
Get available voice agents (platform-aware) for a location
GET
/tasks/api/v1/win-onboarding/area-codes/{areaCode}/alternates
Get alternate area codes
GET
/tasks/api/v1/win-onboarding/agent-context/{entityId}
Get agent context for entity
PUT
/tasks/api/v1/win-onboarding/agent-context/{entityId}
Update agent context for entity
PUT
/tasks/api/v1/win-onboarding/callback/status
Update callback status
POST
/tasks/api/v1/win-onboarding/quick-setup
Quick setup - prepare agent context from existing data
POST
/tasks/api/v1/win-onboarding/feedback
Create WIN feedback
PATCH
/tasks/api/v1/win-onboarding/feedback/{id}
Update WIN feedback
PUT
/tasks/api/v1/win-onboarding/status
Update WIN onboarding status
POST
/tasks/api/v1/win-onboarding/reach-out-list
Create or update reach-out list entry
GET
/tasks/api/v1/win/subscription/config
Get subscription configuration
GET
/tasks/api/v1/win/subscription/status/{entityId}
Get subscription status
POST
/tasks/api/v1/win/subscription/activate-trial
Activate FrontDesk trial subscription
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are t_2 (13 properties), t (12 properties), e (6 properties), e_2 (5 properties). Each schema is shown below with its type and property counts.
Object
object
t
object
12 properties
12 required
e
object
6 properties
3 required
t_2
object
13 properties
6 required
e_2
object
5 properties
5 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zoca 12
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 Blocker API
Zoca App Blocker Updates API
Zoca Approvals API
Zoca Auth API
Zoca Billing API
Zoca Booking Enquiries API
#App
Where this information came from
This is an independent, third-party profile of Zoca App 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.