Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ZenZap Topics (group chats/channels/conversations) API

Operations for managing topics (group chats/channels/conversations)

ZenZap Topics (group chats/channels/conversations) API is one of 8 APIs that ZenZap publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Topics (group chats/channels/conversations). The published artifact set on APIs.io includes an OpenAPI specification and rate-limit docs.

This API exposes 8 operations across 5 paths, and defines 14 schemas. It is described by OpenAPI 3.0.3, at version 2.0.0.

Requests are made against a single base URL, https://api.zenzap.co.

8 operations 5 paths 14 schemas 1 DELETE4 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0.0
Base URL
https://api.zenzap.co
Authentication
HTTP Bearer, API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 3

ZenZap Topics (group chats/channels/conversations) API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as X-Signature (hmacSignature). It supports OAuth 2.0 (oauth2ClientCredentials) using the clientCredentials flow, exposing 12 scopes. By default, every request must be authenticated.

  • bearerAuth — Bearer token for the request. Two flavors: - Static API key — pass your API key (the value returned as apiKey when the bot was created). Must be paired with X-…
  • hmacSignature — HMAC-SHA256 signature for request verification. Required only when authenticating with a static API key. Omit when using an OAuth access token.
  • oauth2ClientCredentials — OAuth 2.0 clientcredentials grant for API-key bots. Use the clientId and clientSecret returned when the bot was created (or rotated) to mint short-lived access…

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Topics (group chats/channels/conversations) 8

Operations for managing topics (group chats/channels/conversations)

GET
/v2/topics
List topics
listTopics 4 params → 200401500
POST
/v2/topics
Create a topic
createTopic 2 params body → 201400401500
GET
/v2/topics/external/{externalId}
Get topic by external ID
getTopicByExternalId 3 params → 200400401404500
GET
/v2/topics/{topicId}
Get topic details
getTopic 3 params → 200400401404500
PATCH
/v2/topics/{topicId}
Update a topic
updateTopic 3 params body → 200400401404500
GET
/v2/topics/{topicId}/messages
Get topic messages
getTopicMessages 12 params → 200400401404500
POST
/v2/topics/{topicId}/members
Add members to a topic
addTopicMembers 3 params body → 200400401404500
DELETE
/v2/topics/{topicId}/members
Remove members from a topic
removeTopicMembers 3 params body → 200400401404500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are MessageItem (14 properties), TopicListItem (9 properties), TopicCreateResponse (5 properties), TopicCreateRequest (4 properties). Each schema is shown below with its type and property counts.

TopicMemberAddRequest
object
1 property 1 required
MessageReaction
object
3 properties
TopicListItem
object
9 properties
MessageMention
object
2 properties
TopicMemberRemoveRequest
object
1 property 1 required
TopicCreateRequest
object
4 properties 2 required
TopicMessagesResponse
object
3 properties
TopicMemberUpdateResponse
object
3 properties
TopicGetResponse
object
4 properties
TopicCreateResponse
object
5 properties
TopicsListResponse
object
3 properties
TopicPatchRequest
object
At least one of name or description must be provided
2 properties
MessageAttachment
object
4 properties
MessageItem
object
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zenzap-topics-group-chats-channels-conversations-api-openapi.yml Raw ↑

Other APIs ZenZap publishes across the network.

ZenZap Agentic API
ZenZap Long Polling API
ZenZap Members API
ZenZap Messages API
ZenZap OAuth API
ZenZap Polls API
ZenZap Tasks API