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

Knock Guides API

The Guides API from Knock — 8 operation(s) for guides.

Knock Guides API is one of 19 APIs that Knock publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Guides. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 9 operations across 8 paths, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://api.knock.app.

9 operations 8 paths 3 schemas 1 DELETE1 GET7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://api.knock.app/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Knock Guides API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 1 DELETE, 1 GET, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Guides 9
PUT
/v1/users/{user_id}/guides/messages/seen
Mark guide as seen
markUserGuideAsSeen (2) 1 param body → 200
PUT
/v1/users/{user_id}/guides/messages/{message_id}/seen
Mark guide as seen
markUserGuideAsSeen 1 param body → 200
DELETE
/v1/users/{user_id}/guides/messages/archived
Mark guide as unarchived
markUserGuideAsUnarchived 1 param body → 200
PUT
/v1/users/{user_id}/guides/messages/archived
Mark guide as archived
markUserGuideAsArchived (2) 1 param body → 200
PUT
/v1/users/{user_id}/guides/messages/interacted
Mark guide as interacted
markUserGuideAsInteracted (2) 1 param body → 200
PUT
/v1/users/{user_id}/guides/engagements/reset
Reset guide engagement
resetUserGuideEngagement 1 param body → 200
GET
/v1/users/{user_id}/guides/{channel_id}
List guides
listUserGuides 5 params → 200
PUT
/v1/users/{user_id}/guides/messages/{message_id}/interacted
Mark guide as interacted
markUserGuideAsInteracted 1 param body → 200
PUT
/v1/users/{user_id}/guides/messages/{message_id}/archived
Mark guide as archived
markUserGuideAsArchived 1 param body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are GuideActionRequest (9 properties), GuidesResponse (4 properties), GuideActionResponse (1 property). Each schema is shown below with its type and property counts.

GuidesResponse
object
A response for a list of guides.
4 properties 4 required
GuideActionRequest
object
A request to trigger a guide action.
9 properties 4 required
GuideActionResponse
object
A response for a guide action.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-guides-api-openapi.yml Raw ↑

Other APIs Knock publishes across the network.

Knock Audiences API
Knock Bulk operations API
Knock Channel data API
Knock Feeds API
Knock Integrations API
Knock Messages API
Knock Microsoft Teams API
Knock Objects API
Knock Preferences API
Knock Providers API
Knock Schedules API
Knock Slack API