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 Offers API

The Offers API from Zoca — 32 operation(s) for offers.

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

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

This API exposes 41 operations across 32 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 3.20.10.

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

41 operations 32 paths 1 schemas 6 DELETE17 GET12 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Zoca Offers 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 41

Across 32 paths, the API surfaces 41 operations — 6 DELETE, 17 GET, 12 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Offers 41
POST
/offers
Create a new offer
t_value → 201
GET
/offers
List all offers
getOffers 2 params → 200
POST
/offers/draft
Create a draft offer with optional fields
postOffersDraft → 201
PUT
/offers/{id}/draft
Update a draft offer with field-by-field updates
putOffersByIdDraft → 200
GET
/offers/{id}
Get offer details
getOffersById 1 param → 200
PUT
/offers/{id}
Update an offer
putOffersById → 200
DELETE
/offers/{id}
Soft delete an offer
deleteOffersById → 200
GET
/offers/v2/list
List offers with optimized data fetching (v2)
getOffersV2List → 200400
GET
/offers/channels/{entityId}
List available channels for offer creation with publishOn dates
getOffersChannelsByEntityId → 200
POST
/offers/description/generate
Generate AI-powered description for an offer
postOffersDescriptionGenerate → 200400404
POST
/offers/description/validate
Validate AI-powered description for an offer
postOffersDescriptionValidate → 200400404
POST
/offers/title/generate
Generate and store AI-powered title for an offer
postOffersTitleGenerate → 200400404
GET
/offers/entities/{entityId}
List all offers on an entity
getOffersEntitiesByEntityId → 200
GET
/offers/entities/{entityId}/status
List all offers on an entity with status
getOffersEntitiesByEntityIdStatus 2 params → 200
GET
/offers/entities/{entityId}/status/count
Get count of offers grouped by status for an entity
getOffersEntitiesByEntityIdStatusCount 2 params → 200
GET
/offers/entities/{entityId}/search
Search offers by title with status calculation
getOffersEntitiesByEntityIdSearch → 200400
GET
/offers/{offerId}/suggestions
Get suggestions for an offer
getOffersByOfferIdSuggestions → 200400
POST
/offers/{id}/duplicate
Duplicate an offer as a new draft
postOffersByIdDuplicate → 201403404
PUT
/offers/{id}/toggle-active
Toggle offer active/inactive status
putOffersByIdToggleActive → 200404
POST
/offers/{id}/entity
Associate an offer with an entity
postOffersByIdEntity → 201
DELETE
/offers/{id}/entity
Remove entity association
deleteOffersByIdEntity → 200
POST
/offers/{id}/services
Add services to an offer
postOffersByIdServices → 201
GET
/offers/{id}/services
List services for an offer
getOffersByIdServices → 200
DELETE
/offers/{id}/services/{serviceId}
Remove a service from an offer
deleteOffersByIdServicesByServiceId → 200
POST
/offers/{id}/media
Add media to an offer
postOffersByIdMedia → 201
GET
/offers/{id}/media
List media for an offer
getOffersByIdMedia → 200
DELETE
/offers/{id}/media/{mediaId}
Remove media from an offer
deleteOffersByIdMediaByMediaId → 200
POST
/offers/{id}/media/{mediaId}/replace
Replace media for an offer
postOffersByIdMediaByMediaIdReplace → 200
POST
/offers/{id}/addons
Add an addon to an offer
postOffersByIdAddons → 201
GET
/offers/{id}/addons
List addons for an offer
getOffersByIdAddons → 200
PUT
/offers/{id}/addons/{addonId}
Update an addon
putOffersByIdAddonsByAddonId → 200
DELETE
/offers/{id}/addons/{addonId}
Delete an addon
deleteOffersByIdAddonsByAddonId → 200
POST
/offers/{id}/ctas
Add CTAs to an offer
postOffersByIdCtas → 201
GET
/offers/{id}/ctas
List CTAs for an offer
getOffersByIdCtas → 200
DELETE
/offers/{id}/ctas/{ctaId}
Remove a CTA from an offer
deleteOffersByIdCtasByCtaId → 200
PUT
/offers/{id}/pause
Pause an active offer
putOffersByIdPause → 200
PUT
/offers/{id}/resume
Resume a paused offer
putOffersByIdResume → 200
GET
/offers/entity/{entityId}/active
Get active discount offers for entity
getOffersEntityByEntityIdActive 2 params → 200
GET
/offers/entity/{entityId}/loyalty
Get active loyalty-channel offers for entity
getOffersEntityByEntityIdLoyalty → 200
GET
/offers/{id}/usage-stats
Get usage statistics for an offer
getOffersByIdUsageStats → 200
GET
/offers/entity/{entityId}/usage-report
Get offer usage report for entity
getOffersEntityByEntityIdUsageReport → 200

Schemas 1

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

e
object
6 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoca-offers-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 Offers 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.